Groups
Update a group
Partial update of a group. Send only the fields that change (`name`, `emoji`, `description`, `parent_id`). **Requires `Idempotency-Key`.** Returns `{ data: { group: {...} } }`.
PATCH /v2/groups/{groupId}
Parameters
Path parameters
groupId
string (uuid) required
Header parameters
Idempotency-Key
string required
Required. UUID per logical operation, reused on every retry. See
apps/rest-api/src/shared/idempotency.ts for the full contract. Missing → 400 BadRequest; same key + different body → 409 Conflict.Request body
Content-Type: application/json
group
object required
group.name
string
group.emoji
string
group.description
string
group.parent_id
string (uuid)
group.parent
any
Example
{
"group": {
"name": "string",
"emoji": "string"
}
}
Responses
200 — Successful response
Content-Type: application/json
data
object required
data.group
any required
Example
{
"data": {
"group": null
}
}
400
No response body.
401
No response body.
403
No response body.
404
No response body.
409
No response body.
429
No response body.
500
No response body.
Code samples
curl https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000 \
--request PATCH \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"group": {
"name": "string",
"emoji": "string"
}
}'
fetch('https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000', {
method: 'PATCH',
headers: {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
group: {
name: 'string',
emoji: 'string'
}
})
})
requests.patch(
"https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000",
headers={
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json"
},
json={
"group": {
"name": "string",
"emoji": "string"
}
}
)
Remove contacts from a group
Remove one or more contacts from a group. The contacts themselves are NOT deleted — only their `groups_contacts` membership rows are removed. **Requires `Idempotency-Key`.** Returns `{ data: { affecte
Delete a group
Permanently delete a group. The contacts in the group are NOT deleted — only their `groups_contacts` membership rows and the group itself are removed. Returns the canonical bulk envelope: `{ data: { a