Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Assistants

Create a scheduled event

Create a scheduled event for an assistant

post/ai/assistants/{assistant_id}/scheduled_events

Path parameters

assistant_idstring required

Unique identifier of the assistant.

Request body

conversation_metadataobject

Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own.

dynamic_variablesobject

A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.

max_retries_client_errorsinteger

Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)

retry_interval_secsinteger
scheduled_at_fixed_datetimestring date-time required

The datetime at which the event should be scheduled. Formatted as ISO 8601.

telnyx_agent_targetstring required

The phone number, SIP URI, to schedule the call or text from.

telnyx_conversation_channel'phone_call' | 'sms_chat' required
telnyx_end_user_targetstring required

The phone number, SIP URI, to schedule the call or text to.

textstring

Required for sms scheduled events. The text to be sent to the end user.

Example request

{
  "scheduled_at_fixed_datetime": "2025-04-15T13:07:28.764Z"
}

Response

Successful Response

OR