Read this contract with the installed version
Use API authentication and request conventions first. Paths below are normalized; mount under the correct local Admin or Customer namespace. Every handler independently enforces current authorization, resource/account scope, feature/licence state and actual installed capability. A listed route is not a token-scope grant or native production acceptance. Read the operational procedure and fields before changing data. The newer source reference includes preparation/activation routes which earlier kits may not expose.
Every route in this family
| Method | Normalized path | Request and effect |
|---|---|---|
| GET | /v1/mail-capabilities |
Read authorized state/content; inspect observation time and pagination. |
| GET | /v1/mail-domains |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-domains |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-domains/{id} |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-domains/{id}/route |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/suspend |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/reactivate |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/delete |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-domains/{id}/mailboxes |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-domains/{id}/mailboxes |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/mailboxes/{mailbox_id}/rotate |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/mailboxes/{mailbox_id}/delete |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-send-policy/{account_id} |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-send-policy/{account_id} |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-queue |
Read authorized state/content; inspect observation time and pagination. |
| GET | /v1/mail-status |
Read authorized state/content; inspect observation time and pagination. |
| GET | /v1/mail-domains/{id}/diagnostics |
Read authorized state/content; inspect observation time and pagination. |
| GET | /v1/mail-domains/{id}/tools |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-domains/{id}/tools |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/dkim/stage |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-domains/{id}/dkim/verify |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-domains/{id}/deliverability |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-domains/{id}/deliverability/test |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-notification-smtp |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-notification-smtp/candidates |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-notification-smtp/candidates/{candidate_id}/test |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-notification-smtp/candidates/{candidate_id}/activate |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-recovery-address |
Read authorized state/content; inspect observation time and pagination. |
| POST | /v1/mail-recovery-address |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| POST | /v1/mail-recovery-address/confirm |
Explicit typed mutation; use the current revision/preview/CSRF or separately authorized token contract as applicable. |
| GET | /v1/mail-webmail |
Read authorized state/content; inspect observation time and pagination. |
Delivery, verification and errors
A returned operation or 202 means accepted work, not completed service change. Retain the operation ID and inspect events and actual resource state. Preserve one idempotency key for a reviewed ambiguous-delivery attempt. Current revision/ETag, exact impact preview and confirmation are separate protection mechanisms; do not guess or reuse stale values.
For 401, restore a valid local session/token. For 403, inspect the actual typed authorization/freshness/licence denial; generic denial is not automatically a password prompt. For 409, reload changed state or inspect the original operation. A capability/storage/agent 503 stays unavailable. Never place passwords, bearer tokens, private keys or recovery material in a URL. The complete request/response field reference distinguishes internal lifecycle models from public client input.