Skip to main content
PATCH
Update an SMS configuration

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Maximum string length: 200
providerKey
enum<string>
Available options:
twilio,
vonage,
pronto_connects
senderKind
enum<string>
Available options:
messaging_service,
number,
provider_managed
senderId
string | null
templateId
string | null
body
string | null
Maximum string length: 1600
isDefault
boolean
isActive
boolean

Response

Updated.

id
string<uuid>
name
string
providerKey
enum<string>
Available options:
twilio,
vonage,
pronto_connects
senderKind
enum<string>
Available options:
messaging_service,
number,
provider_managed
senderId
string | null
templateId
string | null
body
string | null
variables
string[]

What a send needs filled in, in order of first appearance: the plain tokens the body references, with a computed one replaced by what it is worked out from ({{full_name}} by first_name and last_name, {{today}} by tz).

isDefault
boolean
isActive
boolean
createdAt
string<date-time>
updatedAt
string<date-time>