Available methods
-
-
Add a domain to the account, triggering a verification e-mail to the provided address.
POST /verified-domains
Add a domain to the account.
Response body parameters
domain |
Type: String |
Title: Domain Name |
Read only: true |
The name of this domain. |
verified |
Type: Boolean |
Title: Verified |
Read only: true |
Whether the domain has been verified for sending. |
authenticated |
Type: Boolean |
Title: Authenticated |
Read only: true |
Whether domain authentication is enabled for this domain. |
verification_email |
Type: String |
Title: Verification Email |
Read only: true |
The e-mail address receiving the two-factor challenge for this domain. |
verification_sent |
Type: String |
Title: Verification Challenge Sent |
Read only: true |
The date/time that the two-factor challenge was sent to the verification email. |
Error response
type |
Type: String |
Title: Problem Type |
Read only: false |
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. |
title |
Type: String |
Title: Error Title |
Read only: false |
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization. |
status |
Type: Integer |
Title: HTTP Status Code |
Read only: false |
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. |
detail |
Type: String |
Title: Error Message |
Read only: false |
A human-readable explanation specific to this occurrence of the problem. Learn more about errors. |
instance |
Type: String |
Title: Instance ID |
Read only: false |
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. |
-
-
Get all of the sending domains on the account.
GET /verified-domains
Get all of the sending domains on the account.
Response body parameters
domains |
Type: Array |
Title: Domains |
Read only: true |
The domains on the account |
total_items |
Type: Integer |
Title: Item Count |
Read only: false |
The total number of items matching the query regardless of pagination. |
Error response
type |
Type: String |
Title: Problem Type |
Read only: false |
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. |
title |
Type: String |
Title: Error Title |
Read only: false |
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization. |
status |
Type: Integer |
Title: HTTP Status Code |
Read only: false |
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. |
detail |
Type: String |
Title: Error Message |
Read only: false |
A human-readable explanation specific to this occurrence of the problem. Learn more about errors. |
instance |
Type: String |
Title: Instance ID |
Read only: false |
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. |
Get the details for a single domain on the account.
GET /verified-domains/{domain_name}
Get the details for a single domain on the account.
Response body parameters
domain |
Type: String |
Title: Domain Name |
Read only: true |
The name of this domain. |
verified |
Type: Boolean |
Title: Verified |
Read only: true |
Whether the domain has been verified for sending. |
authenticated |
Type: Boolean |
Title: Authenticated |
Read only: true |
Whether domain authentication is enabled for this domain. |
verification_email |
Type: String |
Title: Verification Email |
Read only: true |
The e-mail address receiving the two-factor challenge for this domain. |
verification_sent |
Type: String |
Title: Verification Challenge Sent |
Read only: true |
The date/time that the two-factor challenge was sent to the verification email. |
Error response
type |
Type: String |
Title: Problem Type |
Read only: false |
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. |
title |
Type: String |
Title: Error Title |
Read only: false |
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization. |
status |
Type: Integer |
Title: HTTP Status Code |
Read only: false |
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. |
detail |
Type: String |
Title: Error Message |
Read only: false |
A human-readable explanation specific to this occurrence of the problem. Learn more about errors. |
instance |
Type: String |
Title: Instance ID |
Read only: false |
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. |
-
-
Delete a verified domain
DELETE /verified-domains/{domain_name}
Delete a verified domain from the account.
Error response
type |
Type: String |
Title: Problem Type |
Read only: false |
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. |
title |
Type: String |
Title: Error Title |
Read only: false |
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization. |
status |
Type: Integer |
Title: HTTP Status Code |
Read only: false |
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. |
detail |
Type: String |
Title: Error Message |
Read only: false |
A human-readable explanation specific to this occurrence of the problem. Learn more about errors. |
instance |
Type: String |
Title: Instance ID |
Read only: false |
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. |
-
-
Submit a response to the verification challenge and verify a domain for sending.
POST /verified-domains/{domain_name}/actions/verify
Verify a domain for sending.
Response body parameters
domain |
Type: String |
Title: Domain Name |
Read only: true |
The name of this domain. |
verified |
Type: Boolean |
Title: Verified |
Read only: true |
Whether the domain has been verified for sending. |
authenticated |
Type: Boolean |
Title: Authenticated |
Read only: true |
Whether domain authentication is enabled for this domain. |
verification_email |
Type: String |
Title: Verification Email |
Read only: true |
The e-mail address receiving the two-factor challenge for this domain. |
verification_sent |
Type: String |
Title: Verification Challenge Sent |
Read only: true |
The date/time that the two-factor challenge was sent to the verification email. |
Error response
type |
Type: String |
Title: Problem Type |
Read only: false |
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. |
title |
Type: String |
Title: Error Title |
Read only: false |
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization. |
status |
Type: Integer |
Title: HTTP Status Code |
Read only: false |
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. |
detail |
Type: String |
Title: Error Message |
Read only: false |
A human-readable explanation specific to this occurrence of the problem. Learn more about errors. |
instance |
Type: String |
Title: Instance ID |
Read only: false |
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. |