AuralisDocs
OperationsChannels and email

Re-check this workspace's sending domain with the provider

Ask the provider what it currently sees and write the answer down.

/v1/channels/email/sending-domain/verifyAdmin
Operation id
verify_sending_domain
Access
An editor or a viewer is refused.
POST/v1/channels/email/sending-domain/verify

Ask the provider what it currently sees and write the answer down.

On demand because the person who just published the records is waiting. Every status in the response came from this call; nothing here infers a verification from the records having been returned earlier.

Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.

Authorisation: admin or owner. An editor or viewer receives 403 insufficient_role.

Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:write scope, and the workspace role of the person who owns it must meet the floor above.

Authorization

AuthorizationBearer <token>

A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/channels/email/sending-domain/verify"
{  "connected": true,  "domain": "string",  "from_address": "string",  "mail_from_domain": "string",  "fallback_to_minted": true,  "sendable": true,  "verified_at": "string",  "checks": [    {      "check": "dkim",      "status": "not_started",      "detail": "string",      "remediation": "string",      "last_checked_at": "2019-08-24T14:15:22Z"    }  ],  "records": [    {      "check": "dkim",      "host": "string",      "type": "CNAME",      "value": "string",      "ttl_seconds": 0    }  ],  "observations": [    {      "check": "dkim",      "host": "string",      "type": "CNAME",      "expected": "string",      "observed": [        "string"      ],      "matches": true,      "note": "string"    }  ]}