SautiDesk
SautiDesk API
Channels and templates

Get email settings

GET
/v1/desk/mail/settings

Returns the email settings: the sender name and address customers see, the address they write to, and whether email is switched on.

Requires: desk.read 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

Response

OK

Example

{  "from_name": "Example Support",  "from_address": "help@support.example.com",  "inbound_address": "help@support.example.com",  "enabled": false,  "configured": false}
FieldTypeDescription
from_namerequiredstringThe name customers see on your emails.
from_addressrequiredstringThe address replies are sent from, for example help@support.example.co.ke.
inbound_addressrequiredstringThe address customers write to.
enabledrequiredbooleanTrue to switch it on, false to switch it off.
configuredrequiredbooleanTrue once the email settings have been filled in.
curl -X GET "https://api.sautidesk.com/v1/desk/mail/settings"