CorefinityCorefinityDocs
Open the Control PanelControl Panel
Outbound email · 11 of 12

Send a test email

Sends one test email from the site through a verified sending domain, the default unless domain names another. The answer is a command: when its status is queued or running, follow it with the command endpoint. Beside the limit on changes, a site may send 20 test emails a day (the day in UTC), counted with the tests sent from the Control Panel and by AI assistants: test.remaining_today of the email settings says how many are left, and a test past the last answers 429 limit, which no wait within the day lifts. One test is sent at a time on a site.

POST/api/corestack/sites/{site}/email/test

Path parameters

siteintegerRequired

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

domainstring

The sending domain to send through, by its name or its id. Left out, the default.

tostringRequired

The address to send the test to. At most 254 characters, without quotes or angle brackets. Format: email.

Returns

202 The test was started. command.result holds its outcome once it has finished.

Fields of the 202 answer
commandobjectRequired

One test send.

Fields
blocked_until_verifiedbooleanRequired
duration_msinteger or nullRequired
errorstring or nullRequired
exit_codeinteger or nullRequired
finished_atstring or nullRequired

Format: date-time.

idintegerRequired

At least 1.

inputobjectRequired

What was asked for, to and domain.

kindstringRequired
labelstringRequired
operation_idinteger or nullRequired

At least 1.

output_excerptstring or nullRequired
queued_atstring or nullRequired

Format: date-time.

requested_byobject or any or nullRequired

Who asked for the test. Null when that person's account has since been deleted.

resultobject or any or nullRequired

The outcome, once the send has finished.

siteobjectRequired

A site by its id and domain.

Fields
domainstringRequired
idintegerRequired
started_atstring or nullRequired

Format: date-time.

statusstringRequired

queued and running: the send has not ended, read again. Every other value is final: succeeded, failed, timed_out (the site did not answer in time) and lost (the connection to the site ended before the send reported back). Only succeeded means the email was handed over.

queuedrunningsucceededfailedtimed_outlost
status_labelstringRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
404tenant_mismatchThe object does not exist or the token may not see it. Check the id.
409busyAnother operation is running on the site. Wait for it to finish.
409command_runningAnother action or command is still running on the site. Wait for it to finish, then try again.
409stateWhat the request acts on is not in a state that allows this. Read the message.
422invalidFix the field named in field; errors says why.
429limitA limit on how many of these there can be, or how often this can be done, has been reached. Read the message: remove or close one, or try again later.
429rate_limitedWait for the seconds in Retry-After.
503noneTry again shortly.
503switched_offCorefinity has switched this action off for the moment. Try again later.

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/test \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "[email protected]"
  }'
{
  "command": {
    "blocked_until_verified": false,
    "duration_ms": 0,
    "error": null,
    "exit_code": 0,
    "finished_at": "2026-11-03T09:16:40Z",
    "id": 6187,
    "input": {
      "domain": "mg.harbourandfinch.example.com",
      "to": "[email protected]"
    },
    "kind": "email_test",
    "label": "Send a test email",
    "operation_id": null,
    "output_excerpt": "sent\n",
    "queued_at": "2026-11-03T09:16:40Z",
    "requested_by": {
      "id": 2012,
      "name": "Daniel Reyes"
    },
    "result": {
      "message": "Sent. Check the inbox (and spam) of [email protected].",
      "sent": true
    },
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "started_at": "2026-11-03T09:16:40Z",
    "status": "succeeded",
    "status_label": "Done"
  }
}
Try it

Try it is off for this endpointIt sends email to real people. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT