Idempotency
Idempotency protects supported creation and sending operations from being executed twice when a client retries the same request.
Supported operations
POST /api/v2/customersPOST /api/v2/connectionsPOST /api/v2/messagesPOST /api/v2/groups/{group}/messages
These endpoints require an Idempotency-Key header. The value must contain 8–128 characters from A–Z a–z 0–9 . _ : -.
Choose a key
Generate one key per logical business operation, such as a message send or pairing attempt. Persist that key in your own system before sending the request. Use a new key for a new operation.
Idempotency-Key: operation-12345678
Retry behavior
Reuse the same key with the same HTTP method, path, body, and files when retrying after a transport interruption. A completed matching request returns the recorded response with Idempotency-Replayed: true. Records are retained for approximately 24 hours.
Reusing a key with different request content returns 409. A request that is still being processed may also return 409 with Retry-After.
Replaying a completed sending operation does not consume another message allowance, but it is another API request. Authentication, scopes, account status, and subscription checks still apply before a replay is returned.