groups

Remove contacts from a group (v2)

Changed on

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: { affected, ids, remaining? } } where affected is the count of rows actually deleted, ids echoes the input contact IDs that were applied. Send allowPartial: true to accept a partial success: remaining then lists input IDs the server could not apply inside its request budget — resubmit exactly those under a new Idempotency-Key. Without allowPartial, a write that cannot finish returns a retryable 500 timeout; retrying the same list is safe.

post/v2/groups/{groupId}/contacts/batch-remove

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/groups/{groupId}/contacts/batch-remove
  • Auth: HTTP bearer

Path parameters

groupIdstring uuid required

Headers

Idempotency-Keystring required
Example:01HV8N6X7K3P9Q5R2T4Y6W8Z0A

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

contactIdsstring[] required
allowPartialboolean

Response

Successful response

Changes