AuralisDocs
OperationsChannels and email

Disconnect this workspace's sending domain

Release the claim and the provider identity.

/v1/channels/email/sending-domainAdmin
Operation id
delete_sending_domain
Access
An editor or a viewer is refused.
DELETE/v1/channels/email/sending-domain

Release the claim and the provider identity.

The identity is deleted rather than left verified because it is an account-level object: leaving it behind would keep the platform able to send as a domain no workspace still claims, and would leave the next workspace to connect that domain inheriting a verified state it never proved. A provider refusal is not allowed to block the disconnect: the workspace's claim is released either way and the orphan is logged.

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

curl -X DELETE "https://example.com/v1/channels/email/sending-domain"
{  "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"    }  ]}