SautiDesk
SautiDesk API
Messages

Send a message to an address

POST
/v1/desk/messages

Sends an SMS, WhatsApp or email to a phone number or address given in to. A contact is created if the recipient is new, and the message joins their open ticket or opens one. Set forward_of to forward an existing email.

Requires: desk.write scope, Converse licence.

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

Created

Example

{  "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",  "ticket": {    "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",    "ref": "TCK-4471",    "opened": false  },  "delivery": "delivered",  "error": "",  "replayed": false}
FieldTypeDescription
idrequiredstring (uuid)
ticketrequiredobjectThe ticket the call belongs to, by id or reference such as TCK-4471.
idrequiredstring (uuid)
refrequiredstring
openedrequiredboolean
deliverystring
errorstring
replayedboolean
curl -X POST "https://api.sautidesk.com/v1/desk/messages" \  -H "Content-Type: application/json" \  -d '{    "channel": "sms",    "to": "+254712345678",    "name": "Amina",    "body": "Hi Amina, your order has shipped."  }'