SautiDesk
SautiDesk API
Channels and templates

Update a support email address

PATCH
/v1/desk/mail/addresses/{id}

Changes a support email address, the name shown on mail sent from it, or the queue that receives its mail.

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

Path Parameters

id*string

The address's id (a UUID).

Request Body

application/json

Response

OK

Example

{  "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",  "address": "help@support.example.com",  "name": "Amina Wanjiru",  "domain": "support.example.com",  "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40",  "queue_name": "Support",  "sends": false}
FieldTypeDescription
idrequiredstring (uuid)
addressrequiredstringAn email address.
namerequiredstringA name for it.
domainrequiredstringThe domain you send and receive email on, for example support.example.co.ke.
queue_idrequiredstringThe id of the queue that receives what arrives here.
queue_namerequiredstring
sendsrequiredboolean
curl -X PATCH "https://api.sautidesk.com/v1/desk/mail/addresses/string" \  -H "Content-Type: application/json" \  -d '{    "address": "help@support.example.com",    "name": "Amina Wanjiru",    "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40"  }'