/v1/outreach/bulk-sendQueue 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. account_identifier is the line the whole batch leaves on, spelled as get_comms_senders lists it; empty is the caller's OWN line when they have one (own: true in get_comms_senders), otherwise the workspace's default line, so name it whenever the person named one for the batch. A line not theirs refuses the whole batch (line_refused) before anything is queued. 25 is a size per call, not a cap on the list: a longer list is more calls. Each recipient's own body and subject make this the send for messages worded per person; the same words to everyone is a blast (post_blasts). A recipient may name its thread with conversation_id (an integer id, or the string get_definitions_key_replies answers as conversationId) instead of to: it is a reply on that conversation, to its address, by its medium (the batch's), on its own line, and an email without subject takes the thread's as "Re: …" — the follow-up to people who have not answered. Put the thread's address in to beside it so the approval names each person; a to that is not the thread's refuses that recipient. A recipient's record ({key, row_id}) files its thread on that record; one without it is filed by its address exactly as post_comms_send files it (a record whose phone or email cell holds it), and each result's records says where it landed.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Request body
application/jsonrequiredResponses
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,
"records": "string",
"status": "string",
"to": "string"
}
],
"succeeded": 1.5
}
}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"
}