Skip to main content
PUT
/
v1
/
groups
/
{groupId}
Update a group
curl --request PUT \
  --url https://api.prod.getdex.com/v1/groups/{groupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "group": {
    "name": "<string>",
    "emoji": "<string>",
    "description": "<string>",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent": "<unknown>"
  }
}
'
{
  "error": true,
  "data": {
    "group": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>",
      "parent_group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  }
}

Use cases

  • Rename a group
  • Update group metadata or settings
  • Modify group properties as part of a bulk reorganization

Authorizations

Authorization
string
header
required

Use your Dex API key (e.g. dex_abc123...) as the Bearer token.

Path Parameters

groupId
string<uuid>
required

Body

application/json
group
object
required

Response

Successful response

error
boolean
required
data
object
required