Groups

Add contacts to a group

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: { affecte

POST /v2/groups/{groupId}/contacts

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

contactIds

array<string (uuid)> required

Example

{
  "contactIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

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/contacts \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

fetch('https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000/contacts', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactIds: ['00000000-0000-0000-0000-000000000000']
  })
})

requests.post(
    "https://api.prod.getdex.com/v2/groups/00000000-0000-0000-0000-000000000000/contacts",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "contactIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
)

List contacts in a group

Retrieve contacts in a group. Email and phone relations are omitted by default; request them with `?include[contact_emails]=true` or `?include[contact_phone_numbers]=true`.

Create a note

Create a note (a `timeline_items` row) optionally linked to contacts. Returns the created note in the canonical single-entity envelope.