Skip to content

Update Sms Phone Config

PUT
/sms/phone-numbers/{phone_number}

Change one number’s AI-inbox settings. Omitted fields are left alone.

ai_inbox_enabled decides whether the number’s conversations appear in the inbox at all. auto_respond decides whether the AI REPLIES on it without a human - turning that on puts generated messages in front of real people, so it is the consequential one of the two.

A PATCH in PUT’s clothing, matching the app rather than inventing a second spelling for the same operation.

Authorizations

Parameters

Path Parameters

phone_number
required

Phone number in E.164 form, e.g. +15551234567

string

Phone number in E.164 form, e.g. +15551234567

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Partial update of one SMS number’s AI-inbox settings.

Omitted fields are left alone; this is a PATCH in PUT’s clothing, matching the app exactly rather than inventing a second spelling.

object
ai_inbox_enabled
Any of:
boolean
auto_respond
Any of:
boolean

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

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