Rotate a sending domain's SMTP login
Gives the sending domain a new SMTP login, moves the site onto it and revokes the old one. The login is never answered: the site reads it itself. Beside the limit on changes, a person may start three rotations an hour.
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.
Returns
201 The login is being rotated. Follow operation.id until it completes.
Fields of the 201 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.
A change the Control Panel is making or has made. A save or an action that starts work answers one in operation; read it again by id with GET / until status is completed or failed. Both answers have this shape; the few endpoints that answer a different one say so.
Fields
The cluster the operation runs on.
Why the operation failed, in plain words. Null unless status is failed.
A stable code for the failure.
True when the change applies without a maintenance window.
What the operation did differently on purpose. Empty when nothing.
Fields of each item
Who asked for the change.
Present on some site creations and copies.
Always null here. A one-time result is read once with the reveal endpoint.
nonependingavailableviewedWhat a retry needs first, if anything.
Who revealed a one-time result and when, when there was one.
siteclusterbatchThe website the operation belongs to. Null for a cluster's own operation.
Where a change is. completed and failed are final; every other status means the change is still running and blocks another change to the same site.
pendingcommittedrolling_outexecutingcompletedfailedThe key of the step the operation is at. Null once it has completed.
Fields of each item
One of done, current, todo, failed or skipped.
The kind of change, such as crons_change or redirects_change.
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 | busy | Another operation is running on the site. Wait for it to finish. |
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/rotate \
-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/rotate', (object) []);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/email/rotate', {
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/rotate",
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": null,
"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": false,
"can_rotate": false,
"can_test": true,
"cloudflare": {
"can_write_records": true,
"connected": true,
"written_at": null,
"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": null,
"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": null,
"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": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxa.eu.mail.example.net"
},
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxb.eu.mail.example.net"
},
{
"cloudflare": null,
"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": "verified",
"state_label": "Verified",
"test_reason": null,
"verified_at": "2026-11-03T09:16:40Z"
}
],
"error": null,
"last_checked_at": "2026-11-03T09:16:40Z",
"mailpit": null,
"operation": {
"id": 5122,
"scope": "site",
"status": "executing",
"status_label": "Creating the new credential",
"summary": "New SMTP credential for mg.harbourandfinch.example.com",
"to_version": null,
"type": "mail_rotate",
"type_label": "Email credentials"
},
"records": [
{
"cloudflare": null,
"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": null,
"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": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxa.eu.mail.example.net"
},
{
"cloudflare": null,
"found": null,
"name": "mg.harbourandfinch.example.com",
"priority": 10,
"purpose": "mx",
"required": false,
"state": "missing",
"type": "MX",
"value": "mxb.eu.mail.example.net"
},
{
"cloudflare": null,
"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": "verified",
"state_label": "Verified",
"store_mapping": null,
"test": {
"last_sent_at": null,
"last_to": null,
"remaining_today": 20
},
"verified_at": "2026-11-03T09:16:40Z"
},
"operation": {
"applied_at": "2026-11-03T09:16:40Z",
"can_retry": false,
"cluster": {
"id": 1017,
"name": "Northwind UK 1"
},
"committed_at": null,
"completed_at": null,
"created_at": "2026-11-03T09:16:40Z",
"environment": {
"env_id": "rs-northwind-harbourandfinch-example-com",
"hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
"id": 1042,
"name": "Production",
"role": "production",
"role_label": "Production",
"slug": "production"
},
"error": null,
"failure_reason": null,
"from_version": null,
"hot": false,
"id": 5122,
"install": null,
"label": "New credential created",
"notes": [],
"parent_operation_id": null,
"requested_by": {
"id": 2012,
"name": "Daniel Reyes"
},
"reset_target": null,
"result": null,
"result_state": "none",
"retried_by_operation_id": null,
"retries_operation_id": null,
"retry_requires": null,
"revealed": null,
"scope": "site",
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"status": "executing",
"status_label": "Creating the new credential",
"step": "credential",
"steps": [
{
"key": "credential",
"label": "New credential created",
"state": "current"
},
{
"key": "secret",
"label": "Credentials stored",
"state": "todo"
},
{
"key": "restart_pending",
"label": "Settings sent",
"state": "todo"
},
{
"key": "restarted",
"label": "Settings applied",
"state": "todo"
},
{
"key": "verified",
"label": "New login verified",
"state": "todo"
},
{
"key": "revoked",
"label": "Old credentials revoked",
"state": "todo"
}
],
"subject": null,
"summary": "New SMTP credential for mg.harbourandfinch.example.com",
"to_version": null,
"type": "mail_rotate",
"type_label": "Email credentials"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "busy",
"message": "Another change to this site is in progress. Wait for it to finish.",
"reason": "busy"
}{
"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.