Skip to main content
PATCH
Configure SMS on a Phone Number

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Phone-number row id.

Body

application/json
enabled
boolean
required

false disables. Runtime treats every other value, including omission, as enable; normative contract should require this boolean.

sms_workflow_id
string<uuid> | null

Owned workflow for inbound SMS; read only on enable.

Response

Successful response.

success
enum<boolean>
required
Available options:
true
number
object
required

Full retell_phone_numbers row returned by INSERT/UPDATE RETURNING *. This is not a stable public projection.

Last modified on September 8, 2026