Edit a group

PATCH

/groups/{id}

curl --request PATCH \
  --url https://api.dropslate.top/v1/groups/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "color": "example", "accountIds": [ "example" ] }'

• Production

accountIds replaces membership; it does not merge. Requires write.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Request Body

Media typeapplication/json

object

name

string

description

string

nullable

color

string

nullable

accountIds

Array<string>

Example^generated

{
  "name": "example",
  "description": "example",
  "color": "example",
  "accountIds": [
    "example"
  ]
}

Responses

200

The group as edited.

Media typeapplication/json

object

id

string

name

string

description

string

nullable

color

string

nullable

accountIds

Array<string>

Example^generated

{
  "id": "example",
  "name": "example",
  "description": "example",
  "color": "example",
  "accountIds": [
    "example"
  ]
}

403

The key is missing the “write” scope, or this route needs a signed-in session instead of a key.

Media typeapplication/json

object

code

required

string

message

required

string

hint

string

Example

{
  "code": "not_found",
  "message": "The post does not exist.",
  "hint": "Check the id and try again."
}

404

Does not exist, or belongs to a different workspace - the two look identical from here.

Media typeapplication/json

object

code

required

string

message

required

string

hint

string

Example

{
  "code": "not_found",
  "message": "The post does not exist.",
  "hint": "Check the id and try again."
}