Creates a new domain in the specified account.
Parked Domains: Set parked_domain: true to create a parked domain. Parked domains have limited message volume and are useful for domains that don’t actively send email. Requires parked domain quota in your subscription.
Response includes: - parked_domain (boolean): Indicates if the domain is parked or live - parked_domain_credits (integer): Message credits remaining (only for parked domains) - parked_domain_status (string): Status of parked domain (only for parked domains) - tags (array): Array of tag objects associated with the domain
| Code | Description |
|---|---|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server crashed for some reason |
| Param name | Description |
|---|---|
|
domain required |
Validations:
|
|
domain[address] required |
Address of your domain Validations:
|
|
domain[rua_report] required |
Receives RUA Report against your domain Validations:
|
|
domain[ruf_report] required |
Receives RUF Report against your domain Validations:
|
|
domain[mta_sts_report] optional |
Receives MTA-STS Report against your domain Validations:
|
|
domain[parked_domain] optional |
Set to true to create a parked domain with limited message volume (requires parked domain quota) Validations:
|
|
domain[tag_ids] optional |
Array of tag IDs to attach to the domain Validations:
|
|
domain[tag_names] optional |
Array of tag names to attach to the domain (must exist) Validations:
|
|
domain[mta_sts_policy] optional |
Validations:
|
|
domain[mta_sts_policy][mode] required |
Policy Mode Validations:
|
|
domain[mta_sts_policy][mx] required |
Detected Mail Records Separated by comma eg: custmx.cscdns.net, mail.dmarc.com Validations:
|
|
domain[mta_sts_policy][mx_age] required |
Policy Age (Valid Time in_days) Validations:
|