Channels and templates
List email domains
Lists the email domains added to the workspace, with whether each is verified. Only verified domains can have support addresses.
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
Query Parameters
cursor?string
next_cursor from the previous page. Leave it out for the first page.
limit?integer
Page size: 100 by default, 100 at most.
Response
OK
Example
{ "data": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "domain": "support.example.com", "status": "open", "status_note": "Everything is working", "provider_id": "cc0f979a-6957-429d-9976-306cd2f2304c", "inbound_status": "example", "records": [ { "record": null, "type": null, "name": null, "value": null, "priority": null, "ttl": null, "status": null } ] } ], "next_cursor": "eyJvIjoyNX0", "has_more": false}FieldTypeDescription
datarequiredobject[]idrequiredstring (uuid)domainrequiredstringThe domain you send and receive email on, for example support.example.co.ke.statusrequiredstringThe status to set.status_notestringprovider_idstringinbound_statusrequiredstringrecordsrequiredobject[]recordrequiredstringtyperequiredstringnamerequiredstringA name for it.valuerequiredstringpriorityrequiredstringttlrequiredstringstatusrequiredstringThe status to set.next_cursorrequiredstring | nullhas_morerequiredbooleancurl -X GET "https://api.sautidesk.com/v1/desk/mail/domains"