Skip to main content
PUT
Update SMS verification config

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Body

application/json

Bring your own sender. A present value is stored encrypted; an explicit null or "" removes that key. Required per provider - twilio: twilio_account_sid, twilio_auth_token, twilio_phone_number; telnyx: telnyx_api_key, telnyx_from_number (optional telnyx_messaging_profile_id); vonage: vonage_api_key, vonage_api_secret, vonage_from.

sms_provider
enum<string>
Available options:
twilio,
telnyx,
vonage
twilio_account_sid
string
twilio_auth_token
string<password>
twilio_phone_number
string
telnyx_api_key
string<password>
telnyx_from_number
string
telnyx_messaging_profile_id
string
vonage_api_key
string
vonage_api_secret
string<password>
vonage_from
string

Response

Config saved

success
boolean
provider
string
configured
boolean