Offboard (remove) a domain from the customer
DELETE /v1/domains/{domain}
Accept an offboard for a domain and enqueue the full teardown job: it reaps the live outbound provider sender identities and the outbound_* routing rows, then scrubs the DNS zone/records and the domain row. Returns 202 with a job id and a poll URL (status_url); poll GET /v1/jobs/{job_id} until the status is terminal (succeeded/failed/cancelled). Idempotent; a repeat DELETE dedupes onto the same teardown job. New mailboxes can no longer be created on the domain; mailboxes already created are untouched at the mail layer.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The fully-qualified domain name (e.g. mail.acme.com).
Responses
Section titled “ Responses ”Offboard accepted; poll the returned job for completion.
object
Example
domain_offboardExample
/v1/jobs/job-…Missing or invalid credential.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeAuthenticated but lacking the required scope, or out of quota.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scopeResource not found.
The canonical error envelope. error is a stable machine code.
object
Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).
Example
forbiddenHuman-readable detail (never leaks internals).
Example
missing required scope