Skip to main content

Create a scheduled event

POST 
/ai/assistants/:assistant_id/scheduled_events

Create a scheduled event for an assistant

Request

Path Parameters

    assistant_id Assistant Idrequired

Body

required

    telnyx_conversation_channel ConversationChannelType (string)required

    Possible values: [phone_call, sms_chat]

    telnyx_end_user_target Telnyx End User Target (string)required

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

    telnyx_agent_target Telnyx Agent Target (string)required

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

    scheduled_at_fixed_datetime date-timerequired

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

    text string

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

    conversation_metadata

    object

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

    property name*

    object

    anyOf

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

Responses

201: Successful Response

422: Validation Error

Request samples


curl -L 'https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"telnyx_conversation_channel": "phone_call",
"telnyx_end_user_target": "string",
"telnyx_agent_target": "string",
"scheduled_at_fixed_datetime": "2025-04-15T13:07:28.764Z",
"text": "string",
"conversation_metadata": {}
}'

Response samples


{}