Assistants

Create a scheduled event

Changed on

Create a scheduled event for an assistant

post/ai/assistants/{assistant_id}/scheduled_events

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/ai/assistants/{assistant_id}/scheduled_events
  • Auth: HTTP bearer

Path parameters

assistant_idstring required

Unique identifier of the assistant.

Headers

Idempotency-Keystring

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.

Request body

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.

telnyx_agent_targetstring required

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

scheduled_at_fixed_datetimestring date-time required

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

textstring

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

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

Example request

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

Response

Successful Response

OR

Changes

  • 9621f6123ebcRevision changes
    • warning

      added the new 10011 enum value to the // response property for the response status

    • warning

      added the new domain_graduation_limit_exceeded enum value to the // response property for the response status

  • a6a61a29ecddRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added to the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status