Sign in

v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01353775.9 KB
Conversation

post/v1/conversation/sms/outbound

Request body

phoneNumberstring required

The phone number to send the SMS to in E.164 format. If a customer ID is not provided, the customer will be looked up by phone number. If no customer is found, a new customer will be created.

initialMessagestring

The initial message to send to the customer. If not provided, a workflow ID must be specified and the workflow will generate the opening message.

brandIdstring

The ID of the brand to send the SMS from

customerIdstring

The ID of the customer to message. If not provided, the customer will be looked up by phone number. If no customer is found, a new customer will be created.

workflowIdstring

The ID of the workflow to use for generating the opening message. Required if initialMessage is not provided.

channelConfigIdstring

The ID of the channel config to use for the SMS. If not provided, the first active SMS channel config will be used.

inputDataobject

Input data to pass to the workflow when workflowId is provided.

Example request

{
  "phoneNumber": "+61400000000",
  "initialMessage": "Hi! This is a message from Acme Corp."
}

Response

conversationIdstring required

The ID of the conversation that was created