MailcrateDocs
Sending domains

Add a sending domain

POST
/public/sending-domain

The response lists the DNS records to publish. Then call check-verification.

Requires the sending-domain:write scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Request Body

application/json
  1. body
domain*string
Lengthlength <= 253

Response Body

application/json
  1. response
id*string
domain*string
status*string
Value in"failed""pending""verified"
created*string
Formatdate-time
updated*string
Formatdate-time
verificationToken?string
ownershipToken?string
dkimTokens?array<string>
dkimStatus?string
Value in"failed""pending""verified"
dnsRecords?
lastVerificationCheck?string
Formatdate-time
mailFromDomain?string
mailFromStatus?string
Value in"failed""pending""verified"
dmarcStatus?string
Value in"found""missing"
dmarcRecord?string
suggestedDmarcRecord?
customTrackingDomain?string
configurationSetName?string
trackingDomainStatus?string
Value in"failed""pending""verified"
trackingDnsRecords?
receivesInbound?boolean
inboundDomain?string
inboundStatus?string
Value in"failed""pending""verified"
mxRecords?array<>
lastMxCheck?string
Formatdate-time
Example Request
curl -X POST 'https://api.mailcrate.io/public/sending-domain' \  -H 'Authorization: Api-Key <api_key>' \  -H 'Content-Type: application/json' \  -d '{  "domain": "string"}'
Example Response
{  "id": "string",  "domain": "string",  "status": "failed",  "created": "2019-08-24T14:15:22Z",  "updated": "2019-08-24T14:15:22Z",  "verificationToken": "string",  "ownershipToken": "string",  "dkimTokens": [    "string"  ],  "dkimStatus": "failed",  "dnsRecords": {},  "lastVerificationCheck": "2019-08-24T14:15:22Z",  "mailFromDomain": "string",  "mailFromStatus": "failed",  "dmarcStatus": "found",  "dmarcRecord": "string",  "suggestedDmarcRecord": {    "name": "string",    "type": "string",    "value": "string"  },  "customTrackingDomain": "string",  "configurationSetName": "string",  "trackingDomainStatus": "failed",  "trackingDnsRecords": {},  "receivesInbound": true,  "inboundDomain": "string",  "inboundStatus": "failed",  "mxRecords": [    {}  ],  "lastMxCheck": "2019-08-24T14:15:22Z"}

Send an email POST

Sends one email to one contact. The contact is found by `contactId`, or found or created by `contactEmail`. Content comes from exactly one source: a transactional message (`transactionalMessageId`), a template (`templateId`, filled with `data`), or inline `html` with `subject` and `fromAddress`. Sends by template or inline HTML default to the `marketing` lane, which honours unsubscribes and the frequency cap. Set `"lane": "transactional"` for mail the recipient asked for. Pass `idempotencyKey` to make a retry safe. Requires the `sending:write` scope.

Check a sending domain's DNS POST

Requires the `sending-domain:write` scope.