Keep In Touch

Change a keep-in-touch frequency

Change a frequency's `days` and recompute the due date of every cadence on it. Owners and admins only. 404 `frequency_not_found`, 409 `frequency_exists`. Workspace-only: send the `X-Dex-Workspace` hea

PATCH /v2/keep-in-touch/frequencies/{frequencyId}

Parameters

Path parameters

frequencyId

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

days

integer required

Days between keep-in-touch reminders.

Example

{
  "days": 0
}

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.frequency

object required

data.frequency.id

string (uuid) required

data.frequency.days

integer required

data.frequency.cadence_count

integer required

data.frequency.created_at

string (date-time) required

data.frequency.updated_at

string (date-time) required

Example

{
  "data": {
    "frequency": {
      "id": "00000000-0000-0000-0000-000000000000",
      "days": 0,
      "cadence_count": 0,
      "created_at": "2026-10-23T10:31:51.474Z",
      "updated_at": "2026-10-23T10:31:51.474Z"
    }
  }
}

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/frequencies/00000000-0000-0000-0000-000000000000 \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "days": 0
}'

fetch('https://api.prod.getdex.com/v2/keep-in-touch/frequencies/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    days: 0
  })
})

requests.patch(
    "https://api.prod.getdex.com/v2/keep-in-touch/frequencies/00000000-0000-0000-0000-000000000000",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "days": 0
    }
)

Create a keep-in-touch frequency

Add a frequency of `days` (1 to 3650) to the workspace. Owners and admins only. 409 `frequency_exists` when one of those days exists. Workspace-only: send the `X-Dex-Workspace` header (400 `workspace_

Delete a keep-in-touch frequency

Delete a frequency. When cadences use it, say what happens to them: `?cadences=move&move_to=<frequencyId>` moves them to another frequency (400 `invalid_move_target` otherwise) and `?cadences=delete`