Configure domain receiving
Full keys and dashboard sessions only. Enabling starts pending without a DNS lookup; enabling an enabled domain is a no-op. Disabling a receive-only domain returns 422 invalid_request. Returns 503 unavailable when the sending zone is not configured.
PUT/v1/domains/{domain_id}/receiving
Request body
| Parameter | Description |
|---|---|
enabledrequiredboolean |
Path parameters
| Parameter | Description |
|---|---|
domain_idrequiredstring |
bearerAuthheader
AuthorizationBearer <token>API key: st_live_... or st_test_...
Persisted receiving configuration and latest conclusive MX observation.
application/json- response
enabled*booleanstatus*ReceivingStateValue in
"disabled""pending""verified""failed"required*observed*array<>conflict*booleanlast_checked_at*|Format
date-timenext_check_at*|Format
date-timeRaw HTTP example. Ruby is available in the quickstart only.