No tracking runs without JavaScript.

Skip to content
Sendtier Docs
Dashboard

Enable or disable domain receiving

Requires a full-scope key. Enabling requires a verified domain and a passing receiving MX check; otherwise returns 422 domain_not_verified. Disabling does not require verification or a DNS check. Receiving is optional for sending.

PATCH/v1/domains/{domain_id}

Request body

ParameterDescription
receiving_enabledrequired
boolean
Full request schema and constraints

Request Body

application/json
  1. body
receiving_enabled*boolean

Path parameters

ParameterDescription
domain_idrequired
string
Full parameter schemas and constraints

Path Parameters

domain_id*string

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key: st_live_... or st_test_...

Response Body

The updated domain.

application/json
  1. response
id*string
name*string
status*string
Value in"pending""verified""failed"
receiving_enabled*boolean

Whether this domain accepts mail for inboxes. Requires verified sending DNS and a valid receiving MX when enabled.

records*array<>
receiving_mx?
last_checked_at?string
Formatdate-time
created_at*string
Formatdate-time