POST/v1/blasts/{id}/schedule

Schedule a blast

Freezes a draft blast's audience and names the moment it may go: {"at": "<RFC3339 time>"}, absent meaning now. THIS DOES NOT SEND — it closes the audience and writes two columns, and after it neither the words nor the people can change. post_blasts_id_dispatch is what turns a scheduled blast into messages.

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

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "audienceFilter": {},
    "audienceFrozenAt": "string",
    "body": "string",
    "cancellationReason": "string",
    "cancelledAt": "string",
    "createdAt": "string",
    "createdByUserId": 1,
    "detail": {},
    "id": 1,
    "kind": "string",
    "name": "string",
    "retargetOfBlastId": 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