POST /v1/projects/{id}/platforms/email/domains
Reserves a normalized DNS domain and starts its durable email-provider setup. The accepted provision consumes one email-domain entitlement slot until it fails, is cancelled, or becomes a live resource; the plan’s email.max_email_domains value sets the project limit. The customer resource does not exist until provider identity and DNS setup reach READY; poll the returned operation for progress. A domain may have only one unfinished provision or live resource globally. Email domains have no additional per-domain charge. The Idempotency-Key is required and permanent: replaying the same key and canonical domain returns the original operation forever. Requires the platforms:write permission bound to the project resource in the path.
- TypeScript
- Python
- Rust
TypeScript
Parameters
string
required
Identifies one logical mutation across retries.
string
required
Body
string
required
Returns
202 The domain was reserved and setup was dispatched. GET the Location after the Retry-After interval until the operation is terminal. Operation
Headers: Location. The raw response carries these headers; see Raw responses.
boolean
required
string (date-time)
required
object
string (date-time)
OperationError
string
required
string
required
OperationReason
string
string
required
string (date-time)
OperationState
required
OperationType
required
string (date-time)
required