Skip to content

Compose Inbox Sms

POST
/inbox/sms/compose

COMPOSE AN SMS. WITH save_as_draft FALSE THIS REACHES A REAL PHONE.

Sends through the organisation’s own number and files the message into the SMS thread, so the conversation stays in one place. save_as_draft defaults to FALSE, which means send.

Classified external (inbox:run). from_number must be a number this organisation owns - checked before anything is saved or sent, a 400 otherwise (see the module docstring for why the check lives here).

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Compose an SMS: save it as a draft, or SEND IT TO A REAL PHONE.

save_as_draft defaults to FALSE, which means SEND.

object
body
required

Message text.

string
draft_id
Any of:
string
from_number
required

A number this organisation owns, E.164.

string
save_as_draft

FALSE SENDS THE MESSAGE. True stores a draft.

boolean
thread_id
Any of:
string
to_number
required

The recipient’s number, E.164. A real phone.

string

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string