Provider Domains

Set Domain Forwarding

Forward mail arriving at this domain to another address.

REPLACES the current forwarding configuration rather than merging into it.

post/provider-domains/{domain_id}/forwarding

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/provider-domains/{domain_id}/forwarding
  • Auth: HTTP bearer

Path parameters

domain_idinteger required

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

attributesobject required

Forwarding attributes accepted by the registrar

Response

Successful Response

dataMailboxDomainPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.