Save SMS provider configuration

curl --request POST \ --url https://your-instance.example.com/api/sms/providers/config \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "provider": "twilio", "twilioAccountSid": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "twilioAuthToken": "your-twilio-auth-token", "twilioMessagingServiceSid": "MGxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" } '

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Save credentials for a single SMS provider. Only the fields relevant to provider are read; others may be present but are ignored. All credential strings are trimmed before persistence.

provider

enum<string>

required

Supported SMS providers. twilio and textgrid use the Twilio-compatible REST API; sinch uses Sinch Conversation API for SMS and a separate MMS service.

Available options:

twilio,

sinch,

textgrid

Example:

"twilio"

twilioAccountSid

string

Required when provider is twilio.

twilioAuthToken

string

Required when provider is twilio.

twilioMessagingServiceSid

string

Optional but recommended when provider is twilio.

sinchServicePlanId

string

Required when provider is sinch.

sinchApiToken

string

Required when provider is sinch.

sinchMmsApiKey

string

Optional Sinch MMS API key.

sinchMmsServiceId

string

Optional Sinch MMS service identifier.

textGridAccountSid

string

Required when provider is textgrid.

textGridAuthToken

string

Required when provider is textgrid.

Response

Configuration saved

Shared response for save / set-active / delete operations.

success

enum<boolean>

required

Available options:

true

message

string

Human-readable confirmation (e.g. "twilio SMS configuration saved").