Schedule a template message
POST/v1/desks/:desk_id/conversations/:session_id/scheduled-messages
Schedule a message for future delivery (30 seconds to 14 days ahead) in an open conversation. The payload follows the conversation's channel, resolved from its integration: WhatsApp takes a template, while SMS and RCS take a plain-text { text } body. Email and voice conversations are not supported. At the scheduled time the message is delivered in the original conversation, or skipped silently when it was cancelled, the conversation is no longer open, or the session has expired — it never opens a new conversation. Any reply from the contact cancels all pending scheduled messages for the conversation. WhatsApp template body placeholders must be positional ({{1}}..{{n}}).
Permissions - desks.read and conversations.write. API keys - not supported; requires user (JWT) authentication.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 429
- 500
The message was scheduled successfully
BadRequest
Response Headers
Unique identifier for the API request, useful for debugging and tracking.
abc123xyz789Unauthorized
Response Headers
Unique identifier for the API request, useful for debugging and tracking.
abc123xyz789Forbidden - scheduled messages require user authentication, not API keys
The specified resource was not found
Response Headers
Unique identifier for the API request, useful for debugging and tracking.
abc123xyz789The conversation is not open
The per-session scheduled-message limit (3) has been reached
Internal Server Error
Response Headers
Unique identifier for the API request, useful for debugging and tracking.
abc123xyz789