Skip to content

Set Domain Forwarding

POST
/provider-domains/{domain_id}/forwarding

Forward mail arriving at this domain to another address.

REPLACES the current forwarding configuration rather than merging into it.

Authorizations

Parameters

Path Parameters

domain_id
required

Sending domain id (provider_domains.id) - from GET /provider-domains

integer

Sending domain id (provider_domains.id) - from GET /provider-domains

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Forward mail arriving at this domain somewhere else.

object
attributes
required

Forwarding attributes accepted by the registrar

object
key
additional properties
any

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string