Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Headers

Idempotency-Key
string

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_-]{1,255}$

Body

application/json
messages
object[]
required
Required array length: 1 - 50 elements
sandbox_mode
boolean
default:false

Applies sandbox mode to all messages in the batch. Overrides any per-message sandbox_mode in the messages array.

Response

Multi-Status — all batch responses return 207. When all messages succeed, errors is empty and every item is in data. When one or more fail, the response contains a data array for successes and an errors array for failures.

data
object[]
required
errors
object[]
required
meta
object
required