verified-domains

Verify domain

Verify a domain for sending.

post/3.0/verified-domains/{domain_name}/actions/verify

Request

Path parameters

domain_namestring required

The domain name.

Request body

codestring required

The code that was sent to the email address provided when adding a new domain to verify.

Response

The domain being verified for sending.

authenticatedboolean

Whether domain authentication is enabled for this domain.

domainstring

The name of this domain.

is_free_email_providerboolean

Returns whether the domain used is a public / free email provider. See Limitations of Free Email Addresses for more details.

status'VERIFICATION_IN_PROGRESS' | 'VERIFIED' | 'EXPIRED' | 'ERROR' | 'AUTHENTICATION_IN_PROGRESS' | 'AUTHENTICATION_ERROR' | 'AUTHENTICATED'

The Domain's current status.

verification_emailstring

The e-mail address receiving the two-factor challenge for this domain.

verification_sentstring date-time

The date/time that the two-factor challenge was sent to the verification email.

verifiedboolean

Whether the domain has been verified for sending.

Changes

No recorded changes to this operation across all 1 revision of this API.