Skip to content

Send Desk Sms

POST
/desk/decisions/{decision_id}/send-sms

SENDS A TEXT MESSAGE to a real phone, then resolves the card.

Carrier spend, and unrecallable once gone. Same claim-then-send ordering and the same re-run of the opt-out check as send-reply - see that docstring for why a retry is safe and where it is not.

Authorizations

Parameters

Path Parameters

decision_id
required

Decision id (UUID).

string

Decision id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The rep’s text, as it will arrive on the prospect’s phone.

1600 characters is the app’s ceiling, not a display limit - it is the concatenated-SMS cap, and a longer body is refused rather than truncated.

object
body
required

The message. Reaches a real phone and costs carrier spend.

string
>= 1 characters <= 1600 characters

Responses

200

Successful Response

object
data
required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

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