SautiDesk
SautiDesk API
Channels and templates

Update SMS settings

PUT
/v1/desk/sms/settings

Sets the SMS settings: enabled, the send_url that outgoing texts are posted to, the secret that proves a message came from SautiDesk, and the queue_id that receives replies.

Requires: desk.admin scope, workspace owner or admin.

Authorization

bearerAuth
AuthorizationBearer <token>

A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.

In: header

Request Body

application/json

Response

OK

Example

{  "send_url": "https://example.com/file",  "enabled": false,  "sender_id": "fd8c0bc1-a306-40ce-9f02-35bdd1443c8c",  "configured": false,  "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40",  "queue_name": "Support",  "secret_set": false}
FieldTypeDescription
send_urlrequiredstringThe web address SautiDesk posts each outgoing SMS to.
enabledrequiredbooleanTrue to switch it on, false to switch it off.
sender_idrequiredstringThe name that shows as the sender of your SMS, for example ACMEKE.
configuredrequiredbooleanTrue once the email settings have been filled in.
queue_idstringThe id of the queue that receives what arrives here.
queue_namestring
secret_setrequiredboolean
curl -X PUT "https://api.sautidesk.com/v1/desk/sms/settings" \  -H "Content-Type: application/json" \  -d '{    "send_url": "https://example.com/file",    "secret": "example-secret",    "enabled": false,    "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40"  }'