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

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Params

Param name Description
domain
required

Validations:

  • Must be a Hash

domain[address]
required

Address of your domain

Validations:

  • Must be a String

domain[rua_report]
required

Receives RUA Report against your domain

Validations:

  • Must be one of: true, false, true, false.

domain[ruf_report]
required

Receives RUF Report against your domain

Validations:

  • Must be one of: true, false, true, false.

domain[mta_sts_report]
optional

Receives MTA-STS Report against your domain

Validations:

  • Must be one of: true, false, true, false.

domain[parked_domain]
optional

Set to true to create a parked domain with limited message volume (requires parked domain quota)

Validations:

  • Must be one of: true, false, true, false.

domain[tag_ids]
optional

Array of tag IDs to attach to the domain

Validations:

  • Must be an array of any type

domain[tag_names]
optional

Array of tag names to attach to the domain (must exist)

Validations:

  • Must be an array of any type

domain[mta_sts_policy]
optional

Validations:

  • Must be a Hash

domain[mta_sts_policy][mode]
required

Policy Mode

Validations:

  • Must be one of: testing, enforce.

domain[mta_sts_policy][mx]
required

Detected Mail Records Separated by comma eg: custmx.cscdns.net, mail.dmarc.com

Validations:

  • Must be a String

domain[mta_sts_policy][mx_age]
required

Policy Age (Valid Time in_days)

Validations:

  • Must be one of: 1_day, 2_days, 3_days, 4_days, 5_days, 6_days, 7_days, 2_weeks, 1_month, 2_months, 3_months, 6_months, 12_months.