Create a sending domain's DNS records
Writes the sending domain's DNS records into the Cloudflare zone of a connected Cloudflare account, while the domain waits for DNS; mx: true also writes the optional MX records. A record that could not be written leaves its guidance in email.error. Try-it is off because the request changes live DNS.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
A sending domain of the site, by its name or its id. Left out, the default.
True to write the optional MX records too.
Returns
200 The records were written, as far as they could be.
Fields of the 200 answer
A site's email settings. The top-level fields describe the default sending domain.
Fields
Whether another sending domain can be added.
Fields
The sending domain a set-up creates when it names none.
Every sending domain of the site, the default first.
Fields of each item
Whether the site sends through this domain now.
Format: date-time.
Whether the DNS endpoint can write this domain's records.
Fields
Whether your company has a connected Cloudflare account.
When the records were last written in full. Format: date-time.
The Cloudflare zone the domain is in, or null when it is in none of the connected account's.
The domain of the sender addresses that go through it.
At least 1.
Format: date-time.
The last test email sent through this domain, or null.
The operation that set the domain up. At least 1.
Fields of each item
The record as written in Cloudflare by the DNS endpoint. Null when it was not.
What was found in DNS when it differs from value.
MX records only.
What the record is for, such as spf, dkim, mx, tracking or dmarc.
False for the records sending works without (mx, dmarc).
validuncheckedmismatchmissingThe record type, such as TXT, CNAME or MX.
Fields
The address the site's email comes from.
The name shown beside it.
The domain email is sent through, such as mg.harbourandfinch.example.com.
pending_dns: the domain exists and waits for its DNS records. preview: the site is not live, and its email is caught rather than sent.
previewnot_set_upcreatingpending_dnsverifiedfailedremovingWhy a test cannot be sent, when it cannot.
Format: date-time.
What went wrong with the last set-up or DNS write, in plain words.
Format: date-time.
Where the email of a site that is not live is caught. Null on a live site.
The email change that is running, or null.
Fields of each item
The record as written in Cloudflare by the DNS endpoint. Null when it was not.
What was found in DNS when it differs from value.
MX records only.
What the record is for, such as spf, dkim, mx, tracking or dmarc.
False for the records sending works without (mx, dmarc).
validuncheckedmismatchmissingThe record type, such as TXT, CNAME or MX.
The default sending domain, or null when none is set up.
pending_dns: the domain exists and waits for its DNS records. preview: the site is not live, and its email is caught rather than sent.
previewnot_set_upcreatingpending_dnsverifiedfailedremovingOn a live Magento 2 site with a sending domain, its stores' sender addresses and the sending domain each goes through, as last read on the site. Null otherwise, and until the first read has answered.
Fields
Format: date-time.
How many test emails can still be sent today.
Format: date-time.
How many records were written.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
404 | tenant_mismatch | The object does not exist or the token may not see it. Check the id. |
409 | no_zone | The site's domain is not in a connected Cloudflare zone, or Cloudflare is off for the site. Connect the Cloudflare account that holds the zone. |
409 | deleted | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | not_connected | The outside account this needs is not connected for your company. Connect it first; the message names it. |
409 | provisioning | The site is still being created. Try again in a few minutes. |
422 | state | What the request acts on is not in a state that allows this. Read the message. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/email/dns \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/email/dns', (object) []);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/email/dns', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/corestack/sites/1042/email/dns",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={},
)
data = res.json() if res.content else None{
"email": {
"add": {
"allowed": true,
"count": 1,
"default_prefix": "mg",
"max": 5,
"reason": null
},
"cloudflare": {
"can_write_records": true,
"connected": true,
"written_at": "2026-11-03T09:16:40Z",
"zone": {
"id": "example-zone-id",
"name": "harbourandfinch.example.com"
}
},
"default_domain": "mg.harbourandfinch.example.com",
"domains": [
{
"active": true,
"added_at": "2026-11-03T09:16:40Z",
"added_by": "Daniel Reyes",
"can_make_default": false,
"can_remove": true,
"can_rotate": true,
"can_test": false,
"cloudflare": {
"can_write_records": true,
"connected": true,
"written_at": "2026-11-03T09:16:40Z",
"zone": {
"id": "example-zone-id",
"name": "harbourandfinch.example.com"
}
},
"error": null,
"from_domain": "harbourandfinch.example.com",
"id": 3101,
"is_default": true,
"last_checked_at": "2026-11-03T09:16:40Z",
"last_test": null,
"make_default_reason": null,
"operation_id": 5120,
"records": [
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": null,
"purpose": "spf",
"required": true,
"state": "missing",
"type": "TXT",
"value": "v=spf1 include:mail.example.net ~all"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "pic._domainkey.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "dkim",
"required": true,
"state": "missing",
"type": "TXT",
"value": "k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxa.eu.mail.example.net"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxb.eu.mail.example.net"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "email.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "tracking",
"required": true,
"state": "missing",
"type": "CNAME",
"value": "eu.mail.example.net"
}
],
"remove_reason": null,
"sender": {
"address": "[email protected]",
"name": "Harbour & Finch"
},
"sending_domain": "mg.harbourandfinch.example.com",
"state": "pending_dns",
"state_label": "Waiting for DNS",
"test_reason": "Test emails can be sent once the sending domain is verified",
"verified_at": null
}
],
"error": null,
"last_checked_at": "2026-11-03T09:16:40Z",
"mailpit": null,
"operation": null,
"records": [
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": null,
"purpose": "spf",
"required": true,
"state": "missing",
"type": "TXT",
"value": "v=spf1 include:mail.example.net ~all"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "pic._domainkey.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "dkim",
"required": true,
"state": "missing",
"type": "TXT",
"value": "k=rsa; p=SYNTHETIC-DKIM-PUBLIC-KEY"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxa.eu.mail.example.net"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxb.eu.mail.example.net"
},
{
"cloudflare": {
"record_id": "example-record-id",
"written_at": "2026-11-03T09:16:40Z"
},
"found": null,
"name": "email.mg.harbourandfinch.example.com",
"priority": null,
"purpose": "tracking",
"required": true,
"state": "missing",
"type": "CNAME",
"value": "eu.mail.example.net"
}
],
"sender": {
"address": "[email protected]",
"name": "Harbour & Finch"
},
"sending_domain": "mg.harbourandfinch.example.com",
"state": "pending_dns",
"state_label": "Waiting for DNS",
"store_mapping": null,
"test": {
"last_sent_at": null,
"last_to": null,
"remaining_today": 20
},
"verified_at": null
},
"written": 5
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "no_zone",
"message": "Cloudflare is switched off for this site",
"reason": "no_zone"
}{
"code": "state",
"message": "The records can be added while the domain waits for DNS",
"reason": "state"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.