Keep In Touch

Add keep-in-touch cadences in bulk

Add the Team cadence (`kind: 'team'`; owners, admins and standard members) or the caller's own My cadence (`kind: 'my'`; every member, viewers included) on one frequency to up to 1000 contacts (`conta

POST /v2/keep-in-touch/cadences/batch-create

Parameters

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

kind
string enum required
Possible values: "team", "my"
frequency_id
string (uuid) required
contact_ids
array<string (uuid)> required

Example

{
  "kind": "team",
  "frequency_id": "00000000-0000-0000-0000-000000000000",
  "contact_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

201 — Created

Content-Type: application/json

data
object required
data.cadences
array<object> required
data.cadences[].id
string (uuid) required
data.cadences[].kind
string enum required
Possible values: "team", "my"
data.cadences[].contact_id
string (uuid) required
data.cadences[].frequency_id
string (uuid) required
data.cadences[].days
integer required
data.cadences[].next_due_at
string (date-time) required
data.cadences[].snoozed_until
string (date-time) required
data.cadences[].created_at
string (date-time) required
data.cadences[].updated_at
string (date-time) required
data.cadences[].contact
object required
data.cadences[].contact.id
string (uuid) required
data.cadences[].contact.first_name
string | null required
data.cadences[].contact.last_name
string | null required
data.cadences[].contact.image_url
string | null required
data.cadences[].contact.job_title
string | null
data.skipped_existing_contact_ids
array<string (uuid)> required
data.not_found_contact_ids
array<string (uuid)> required

Example

{
  "data": {
    "cadences": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "kind": "team",
        "contact_id": "00000000-0000-0000-0000-000000000000",
        "frequency_id": "00000000-0000-0000-0000-000000000000",
        "days": 0,
        "next_due_at": "2026-10-23T10:31:51.470Z",
        "snoozed_until": "2026-10-23T10:31:51.470Z",
        "created_at": "2026-10-23T10:31:51.470Z",
        "updated_at": "2026-10-23T10:31:51.470Z",
        "contact": {
          "id": "00000000-0000-0000-0000-000000000000",
          "first_name": "string",
          "last_name": "string",
          "image_url": "string"
        }
      }
    ],
    "skipped_existing_contact_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "not_found_contact_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)
any

401 — Missing or invalid API key.

Content-Type: application/json

(body)
any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)
any

404 — Resource does not exist.

Content-Type: application/json

(body)
any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)
any

429 — Rate limit exceeded.

Content-Type: application/json

(body)
any

500 — Unexpected server error.

Content-Type: application/json

(body)
any

Code samples

curl https://api.prod.getdex.com/v2/keep-in-touch/cadences/batch-create \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "kind": "team",
  "frequency_id": "00000000-0000-0000-0000-000000000000",
  "contact_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'
Copyright © 2026