POST/v1/outreach/bulk-send

Queue personalized messages

Queue up to 25 SMS, iMessage or email recipients through the shared send path. Each recipient may override body and subject and carry expected_last_message_id (latest reviewed message, 0 only for verified empty history). Results distinguish queued, skipped and rejected; succeeded means queued, not delivered. Duplicate destinations in one request are skipped. Never blindly replay partial or unknown outcomes. Sender selection uses the workspace service, not a caller-specified phone.

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.

Request body

application/jsonrequired

bodyoptional

paramsobjectoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "failed": 1.5,
    "queued": 1.5,
    "requested": 1.5,
    "results": [
      {
        "conversationId": 1.5,
        "error": "string",
        "id": 1.5,
        "ok": true,
        "status": "string",
        "to": "string"
      }
    ],
    "succeeded": 1.5
  }
}

datarequired

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