Skip to main content
Some requests have effects you cannot undo, such as dialing a phone. These endpoints require an Idempotency-Key header:
  • POST /v1/calls
  • POST /v1/campaigns/{id}/start
  • POST /v1/contacts/imports
Use a unique value for each logical operation, for example a UUID. Keys are 8 to 255 characters.

Behavior

  • Send the same key and the same body again within 24 hours and you get the stored response. No second call is placed.
  • Send the same key with a different body and you get 409 with idempotency.key_reused.
  • Send the same key while the first request is still running and you get 409 with idempotency.in_progress. Wait a moment and retry.
  • Leave the header out on an endpoint that requires it and you get 400 with idempotency.key_required.
Generate the key once, before the first attempt, and reuse it on every retry of that attempt.