Get the list of domains. Can be filtered by state or authority. Sorting is optional. The list is paginated and limited to 1000 items per page.
{- "total_count": 1,
- "items": [
- {
- "created_at": "RFC1123 formatted date",
- "disabled": {
- "code": "blacklisted",
- "note": "for debugging",
- "permanently": true,
- "reason": "bad customer"
}, - "id": "1",
- "name": "example.com",
- "state": "unverified",
- "type": "custom",
- "web_prefix": "email"
}
]
}
Creates a domain for sending emails
{- "receiving_dns_records": [
- {
- "cached": [ ],
- "name": "example.com",
- "priority": "10",
- "record_type": "MX",
- "valid": "unknown"
}
], - "sending_dns_records": [
- {
- "cached": [
- "list",
- "of",
- "cached",
- "mx",
- "records"
], - "name": "example.com",
- "priority": "10",
- "record_type": "A",
- "valid": "valid",
- "value": "1.2.3.4"
}
], - "message": "Domain DNS records have been created",
- "domain": {
- "smtp_login": "postmaster@example.com",
- "use_automatic_sender_security": true,
- "id": "123456789012345678901234",
- "name": "example.com",
- "state": "active",
- "web_prefix": "email",
- "type": "sandbox",
- "require_tls": true,
- "web_scheme": "http",
- "created_at": "Thu, 13 Oct 2011 18:02:00 GMT",
- "spam_action": "disabled"
}
}
Fetches json representation of a domain that includes details about the domain's state and settings.
A 200 response
required | object |
Array of objects | |
Array of objects |
A 401 response
A 404 response
{- "domain": {
- "name": "example.com",
- "created_at": "Thu, 13 Oct 2011 18:02:00 GMT",
- "require_tls": true,
- "smtp_login": "postmaster@example.com",
- "web_prefix": "email",
- "id": "123456789012345678901234",
- "type": "sandbox",
- "use_automatic_sender_security": true,
- "spam_action": "disabled",
- "state": "active",
- "web_scheme": "http"
}
}
Update domains configuration like smtp credentials, enable/disable automatic sender security, spam actions, wildcard, or tracking web scheme.
{- "receiving_dns_records": [
- {
- "cached": [ ],
- "name": "example.com",
- "priority": "10",
- "record_type": "MX",
- "valid": "unknown"
}
], - "sending_dns_records": [
- {
- "cached": [
- "list",
- "of",
- "cached",
- "mx",
- "records"
], - "name": "example.com",
- "priority": "10",
- "record_type": "A",
- "valid": "valid",
- "value": "1.2.3.4"
}
], - "domain": {
- "type": "sandbox",
- "smtp_login": "postmaster@example.com",
- "spam_action": "disabled",
- "name": "example.com",
- "require_tls": true,
- "web_prefix": "email",
- "web_scheme": "http",
- "id": "123456789012345678901234",
- "state": "active",
- "use_automatic_sender_security": true,
- "created_at": "Thu, 13 Oct 2011 18:02:00 GMT"
}
}
Verify the domains DNS records (includes A, CNAME, SPF, DKIM and MX records) to ensure the domain is ready and able to send
{- "message": "Domain DNS records have been updated",
- "domain": {
- "use_automatic_sender_security": true,
- "id": "123456789012345678901234",
- "spam_action": "disabled",
- "type": "sandbox",
- "web_prefix": "email",
- "disabled": {
- "reason": "bad customer",
- "code": "blacklisted",
- "note": "for debugging",
- "permanently": true
}, - "name": "example.com",
- "require_tls": true,
- "smtp_login": "postmaster@example.com",
- "state": "unverified",
- "web_scheme": "http",
- "created_at": "RFC1123 formatted date"
}, - "sending_dns_records": [
- {
- "cached": [
- "list",
- "of",
- "cached",
- "mx",
- "records"
], - "name": "example.com",
- "priority": "10",
- "record_type": "the record type like CNAME, MX, DKIM, ...",
- "valid": "either valid or unknown",
- "value": "value from cache or name server"
}
], - "receiving_dns_records": [
- {
- "cached": [
- "list",
- "of",
- "cached",
- "mx",
- "records"
], - "name": "example.com",
- "priority": "10",
- "record_type": "the record type like CNAME, MX, DKIM, ...",
- "valid": "either valid or unknown",
- "value": "value from cache or name server"
}
]
}
The domain must not be disabled or used as an authority for an other domain. Sandbox domain can't be deleted.
{- "message": "Domain will be deleted on the background"
}
Deprecated: please use PUT /v4/domains/{name} instead.Set both incoming and outgoing message retrieval TTL. The max TTL depends on your plan
A 200 response
required | object |
required | object |
A 400 response
A 401 response
A 404 response
{- "message": "Domain message TTL settings updated."
}
Deprecated: please use PUT /v4/domains/{name} instead.Update the MAILFROM hostname used by default for emails sent using the domain.
{- "message": "success"
}
Deprecated: please use PUT /v4/domains/{name} instead.This updates the web prefix used for a domain's tracking features. This impacts click, open, and unsubscribe tracking features. Note: Updating the web prefix for a domain will require also updating the domain's DNS to include the CNAME record to match.For example, if you set the web prefix to zed
for the domain my-domain.com
, the corresponding CNAME zed.my-domain.com
will need to be created in your domain's dns zone.
{- "message": "Domain web prefix updated"
}