Create a scheduled event
Create a scheduled event for an assistant
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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.
1 - 255^[A-Za-z0-9_-]{1,255}$Path Parameters
Unique identifier of the assistant.
Body
phone_call, sms_chat The phone number, SIP URI, to schedule the call or text to.
The phone number, SIP URI, to schedule the call or text from.
The datetime at which the event should be scheduled. Formatted as ISO 8601.
"2025-04-15T13:07:28.764Z"
Required for sms scheduled events. The text to be sent to the end user.
Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own.
A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.
Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)
0 <= x <= 1060 <= x <= 86400Per-call telephony overrides applied when a scheduled phone-call event dispatches. Phone-call events only. New per-call dispatch options should be added here rather than as top-level event fields.
Response
Successful Response
- ScheduledPhoneCallEventResponse
- ScheduledSmsEventResponse
Union type for different scheduled event response types
phone_call, sms_chat pending, in_progress, completed, failed A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.
Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
Duration of the call in seconds
Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)
Date time at which call was sent
Per-call telephony overrides applied when a scheduled phone-call event dispatches. Phone-call events only. New per-call dispatch options should be added here rather than as top-level event fields.