domains

Change custom domain pod scope

Change which pods can create inboxes on a custom domain. Pass podId: null to make it account-wide (always allowed), or a pod id to scope it to that pod — allowed only while every inbox on the domain already lives in that pod, since inboxes cannot move between pods. DNS records and verification are untouched. Requires an account-wide API key.

patch/v1/domains/{id}

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/domains/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

podIdstring nullable required

Pod to scope the domain to (id or clientId). null makes the domain available to all pods.

Response

Scope changed; the returned domain reflects the new podId

idstring

OpenMail domain ID

domainstring

The domain or subdomain, e.g. example.com or agent-mail.example.com.

podIdstring nullable

Pod this domain is scoped to, so only inboxes in that pod can use it, or null for an account-wide domain.

status'pending' | 'verifying' | 'verified' | 'failed' | 'under_review'

pending — added, records not yet published. verifying — being checked. verified — sending and receiving enabled. failed — records missing or wrong; publishing them and calling verify again is the fix. under_review — flagged as suspicious; DNS setup is blocked until approved.

verifiedAtstring date-time nullable
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.