groups

Add contacts to a group (v2)

Changed on

Add one or more contacts to a group by providing an array of contact IDs. Contacts that are already members are silently skipped server-side. Requires Idempotency-Key. Returns { data: { affected, ids, remaining? } } where affected is the count of NEW memberships created, 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 — nothing about them was committed, so 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

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/groups/{groupId}/contacts
  • 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