Skip to main content

Send outbound message

POST 
/v1/desks/:desk_id/conversations/outbound

Send an outbound message to initiate a conversation with a user via WhatsApp, SMS, RCS, or Email.

Session Reuse Behavior:

  • If an open conversation exists for this user on the same integration → returns 409 Conflict with the existing session_id
  • If a closed conversation exists → a standalone send reuses user context from that conversation (request context overwrites)
  • If no conversation exists → creates a new session

Campaign-linked send: Pass campaign_id and subscriber_id together to continue an existing campaign instead of creating a standalone send. The campaign must be in progress and external_id must match the subscriber's phone or email. The send is recorded as a sender on that campaign, so its receipts land in the subscriber events and the campaign journey. A linked send uses the subscriber's context; only request context overrides it.

Response Status:

  • 201 Created: Message queued successfully. The status field indicates:
    • processed: Message delivery confirmed within 5 seconds
    • pending: Message queued but delivery not yet confirmed

Permissions - desks.read and conversations.create. API keys - manage. A campaign-linked send also needs campaigns.write, and an MCP token is refused.

Request​

Responses​

Message queued successfully

Last updated on