Groups
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
DELETE /v2/groups/{groupId}
Parameters
Path parameters
groupId
string (uuid) required
Header parameters
Idempotency-Key
string
Optional. Accepted to dedupe retries on this endpoint. See
apps/rest-api/src/shared/idempotency.ts.Responses
200 — Successful response
Content-Type: application/json
data
object required
data.affected
integer required
data.ids
array<string>
data.failed
array<object>
data.failed[].id
string
data.failed[].error
object
data.failed[].error.code
string
data.failed[].error.message
string
Example
{
"data": {
"affected": 0
}
}
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 DELETE \
--header 'Authorization: Bearer YOUR_API_KEY'
fetch('https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000', {
method: 'DELETE',
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
})
requests.delete(
"https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000",
headers={
"Authorization": "Bearer YOUR_API_KEY"
}
)
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: {...} } }`.
List groups
List all of the authenticated user's groups. Returns the canonical list envelope: `{ data: { groups: [...] } }`. Supports `?orderBy[name]=asc|desc` and `?orderBy[number_of_contacts]=asc|desc`, plus `?