Skip to main content
POST
Verify the customer endpoint and enable receiving

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Authorized mail result.

domain_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
domain
string
required
environment_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
sending
enum<string>
required
Available options:
disabled,
pending,
ready,
failed
receiving
enum<string>
required
Available options:
disabled,
pending,
ready,
failed
status
enum<string>
required
Available options:
ready,
verification_pending
configured_at
string<date-time>
required
observed_at
string<date-time> | null
required
dns_records
object[]
required
webhook
object | null
required
next_check_after_seconds
enum<integer> | null
required
Available options:
60,
null
dns
object