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

Get a test email's progress

Answers a test send of this site. Read it until status is neither queued nor running: result.sent then says whether the email was handed over, and result.message what to do next.

GET/api/corestack/sites/{site}/email/commands/{command}

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.

commandintegerRequired

The id of a command a test send answered. At least 1.

Returns

200 The test send as it stands.

Fields of the 200 answer
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>.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "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
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT