Skip to main content
POST
Create Sms

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating an SMS draft.

Exactly one body source must be provided: body, sms_template_id, or options.use_llm.

invoices
string[]
required

List of invoice IDs to link to the SMS

Minimum array length: 1
partner_id
string
required

Partner ID to send the SMS to

sms_template_id
string | null

SMS template ID to render

body
string | null

Manual SMS body text

options
object

Options for SMS draft creation.

Response

Successful Response

SMS message within a thread.

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
sms_thread_id
string | null
required
body
string
required

The message content

classifications
InteractionClassification · object[]
required
direction
enum<string>
required
Available options:
inbound,
outbound
from_number
string<phone>
required

The sending phone number

to_number
string<phone>
required

The receiving phone number

status
enum<string>
required
Available options:
draft,
pending,
sent,
delivered,
failed,
undelivered
is_automated
boolean
required

Whether the SMS was automatically sent by a workflow

sent_at
string<date-time> | null
required
delivered_at
string<date-time> | null
required
error_message
string | null
required

Twilio error message if delivery failed

object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.