Set up your email sender domain

Register the domain emails should come from and get its verification checks. Use this once when setting up white-label email. If the same sender (email and tracking_domain) is already fully verified, only its name is updated and status is already_verified.

Prerequisites: a bearer token, the account's id (company_id), and a sender address and tracking subdomain on a domain you control.

Authentication: Partner or Account token. company_id must be inside your own account tree (a Partner token reaches any account under the partner, an Account token only its own); otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 5994

The account. Must exist and be inside your account tree.

string
required
length ≤ 100
Defaults to Acme Reviews

The name emails come from. Up to 100 characters, no angle brackets.

string
required
Defaults to [email protected]

The sender address. Must be a valid address on a domain that exists in DNS; the domain is checked with our email provider.

string
required
length ≤ 100
Defaults to track.acme.com

The domain used for link tracking, e.g. track.acme.com. Up to 100 characters, no angle brackets.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json