GET
/v1/email-blasts/{id}Read one email blast
One EMAIL blast by id — the blast itself, its audience and outcome counts, and a sample of up to 25 recipients. The kind comes from the PATH, so an SMS blast's id is a not-found here and get_sms-blasts_id is its twin. This is the cheap read for an opened blast; reach for get_blasts_id_report instead when the question needs the whole audience, the lines the copies went out on, and who replied.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
idpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:idstringoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": {
"audienceFilter": {},
"audienceFrozenAt": "string",
"body": "string",
"cancellationReason": "string",
"cancelledAt": "string",
"counts": {
"audience": 1,
"outcomes": {}
},
"createdAt": "string",
"createdByUserId": 1,
"detail": {},
"id": 1,
"kind": "string",
"name": "string",
"retargetOfBlastId": 1,
"sample": [
{
"addedAt": "string",
"address": "string",
"displayName": "string",
"lastOutcome": "string",
"sourceRowId": ""
}
],
"sampleLimit": 1,
"scheduledAt": "string",
"sentAt": "string",
"status": "string",
"subject": "string",
"templateId": 1,
"updatedAt": "string"
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired