/v1/blasts/{id}/dispatchSend a scheduled blast
Sends a scheduled blast, and is the only verb that does: it expands into one ordinary outbound message per audience address, each in that address's own thread, and the rail draining the outbox carries them. Body: medium (absent takes the blast's kind — "sms" for a text blast, "email" for an email one; a text blast may ask for "imessage" instead, and a crossed pair is refused) and limit (bounds this run; addresses past it are ledgered skipped with the reason rather than dropped). IDEMPOTENT: a blast already dispatched is answered from its ledger with created: 0, so a retried request cannot message an audience twice. This is the many-people send; post_comms_send is the one-person one.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"audience": 1,
"blastId": 1,
"created": 1,
"medium": "string",
"states": {},
"status": "string"
}
}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"
}