keep-in-touch

Delete a keep-in-touch frequency (v2)

Changed on

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 deletes them; with neither, 409 frequency_in_use with details.cadence_count. Owners and admins only. Workspace-only: send the X-Dex-Workspace header (400 workspace_context_required without it). Idempotency-Key is optional. Returns { data: { frequency_id, cadences_moved, cadences_deleted } }.

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

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/keep-in-touch/frequencies/{frequencyId}
  • Auth: HTTP bearer

Path parameters

frequencyIdstring uuid required

Query parameters

cadences'move' | 'delete'

What happens to the cadences on this frequency: 'move' them to move_to, or 'delete' them. Required when any exist.

move_tostring uuid

The frequency to move the cadences to; with cadences=move.

Headers

Idempotency-Keystring
Example:01HV8N6X7K3P9Q5R2T4Y6W8Z0A

Optional. Accepted to dedupe retries on this endpoint. See apps/rest-api/src/shared/idempotency.ts.

Response

Successful response

Changes