Create a domain | Nexiom Connect

Authorization

Bearer token

Authorizationrequiredheader: Send your API key as Bearer YOUR_API_KEY.
Permissionemail.full_access

Body parameters

application/json

domainrequiredstring: A valid subdomain such as mail.example.com. Root domains are not accepted.
openTrackingoptionalboolean: Defaults to true.

Response

application/json200 OK

The domain is returned under data.

idstring: Domain identifier.
domainstring: Sending subdomain.
statusstring: One of"pending""verified""failed"
regionstring: Sending region.
open_trackingboolean: Whether open tracking is enabled.
verification_errorstring or null: What still needs attention when the domain is not verified.
verification_attemptsnumber: How many verification checks ran.
verification_attempted_atstring or null: When the last verification check ran.
dns_recordsarray: DNS records to publish, each with id, purpose, record_type, name, value, priority, status, required_for_sending, last_checked_at, error_code, and error_message.
last_verified_atstring or null: Last successful verification timestamp.
created_atstring: Creation timestamp.
updated_atstring: Last change timestamp.

Publish the returned DNS records with your DNS provider, then verify the domain.

curl -X POST "https://api-connect.nxiom.com/api/v1/emails/domains" \ -H "Authorization: Bearer $NEXIOM_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "domain": "mail.example.com", "openTracking": true }'

{ "data": { "id": "domain_example", "domain": "mail.example.com", "status": "pending", "region": "global", "open_tracking": true, "last_verified_at": null, "dns_records": [ { "id": "dns_example", "purpose": "dkim", "record_type": "CNAME", "name": "selector._domainkey.mail.example.com", "value": "selector.dkim.example.net", "priority": null, "status": "pending", "required_for_sending": true } ] } }

Authorization#

Body parameters#

Response#

Authorization

Body parameters

Response