Channels and templates
Verify an email domain
Checks whether the DNS records are in place and marks the domain verified if they are. DNS changes can take time to propagate, so retry later if it fails.
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 domain's id (a UUID).
Response
OK
Example
{ "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": "example", "type": "billing", "name": "Amina Wanjiru", "value": "example", "priority": "normal", "ttl": "example", "status": "open" } ]}FieldTypeDescription
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.curl -X POST "https://api.sautidesk.com/v1/desk/mail/domains/string/verify"