Conversations

Schedule an outbound conversation

Create a scheduled outbound WhatsApp conversation that fires at a future time.

post/api/v1/conversations/scheduled

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/conversations/scheduled
  • Auth: bearerAuth (a scheme the document does not define)

Request body

agentIdstring uuid required

Agent ID to handle the conversation

toNumberstring required

Destination phone number (E.164 format)

fromNumberstring required

Sending phone number

scheduledAtstring date-time required

UTC datetime to send the message (ISO 8601)

payloadobject

Variable data for the message template

preferConversationIdstring

If provided, attach the scheduled send to this specific conversation (must belong to org and match toNumber)

messagePreviewstring

Human-readable preview of the scheduled message content, shown as a ghost bubble in the inbox thread

templateKeywordstring

WhatsApp template keyword for meta/ainumber providers. Stored in conversation metadata at schedule time so the scheduled send does not need to re-load agent config.

Example request

{
  "agentId": "550e8400-e29b-41d4-a716-446655440000",
  "toNumber": "+521234567890",
  "fromNumber": "+1555000000",
  "scheduledAt": "2026-05-10T15:00:00.000Z"
}

Response

Created

successtrue required
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.