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.
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.
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
Format: date-time.
At least 1.
What was asked for, to and domain.
At least 1.
Format: date-time.
Who asked for the test. Null when that person's account has since been deleted.
The outcome, once the send has finished.
A site by its id and domain.
Fields
Format: date-time.
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_outlostIf it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | feature_off | This feature is not on for your organisation yet. |
429 | rate_limited | Wait 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// 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.get(
"https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"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"
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}