Configure sending and receiving on a selected mail domain

One production mail domain per project; environment_id is the project Prod environment ID. Dev and Prod application URLs do not create separate mail domains. Provider credentials never leave ohmyho.st. Content expires 72 hours after original receipt.

put/v1/projects/{project_id}/environments/{environment_id}/mail-domain

Request

  • Base URL: https://app.ohmyho.st
  • URL: https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain
  • Auth: HTTP bearer

Path parameters

project_idstring required
environment_idstring required

Headers

X-Request-Idstring

Optional caller-provided correlation identifier.

Idempotency-Keystring required

Identifies one mutation and its canonical request payload.

Request body

domainstring required
sendingboolean required
receivingboolean required

Response

Authorized mail result.

domain_idstring required
domainstring required
environment_idstring required
sending'disabled' | 'pending' | 'ready' | 'failed' required
receiving'disabled' | 'pending' | 'ready' | 'failed' required
status'ready' | 'verification_pending' required
configured_atstring date-time required
observed_atstring date-time nullable required
next_check_after_seconds60 | null nullable required

Changes

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