ComRaidComRaid Docs
API referenceCampaigns

Create a Multi-send Campaign

Multi-send creates one Campaign and one child Message per recipient, each with its own Content. Recipients are addressed by External user ID. There is no RPC-style `/send` path.

POST
/campaigns

Multi-send creates one Campaign and one child Message per recipient, each with its own Content. Recipients are addressed by External user ID. There is no RPC-style /send path.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Header Parameters

Idempotency-Key?string

Project-scoped retry key. Same key + same body replays the stored 202 response. Same key + different body returns 409 idempotency_conflict. Same key while the first request is incomplete returns 409 idempotency_in_progress.

Request Body

application/json
  1. body

Multi-send body. Each recipient is one Contact (by External user ID) with its own Content. The API creates one Campaign and one Message per recipient. Recipients are capped at 10,000 (same Contact cap as Single-send to.external_user_ids).

channel*"push"

Required. Only push is accepted in V1.

Value in"push"
name?string

Optional Campaign label for inspection

recipients*array<>

Per-Contact Contents. Maximum 10,000 recipients.

Items1 <= items <= 10000

Response Body

Accepted (new create or idempotent replay of a completed key). Replay returns the original CampaignAccepted body.

application/json
  1. response
campaign_id*string
Formatuuid
channel*string
status*string
Value in"queued""processing""completed""failed""cancelled"
message_count?integer
messages*array<>
Example Request
curl -X POST 'https://api.comraid.io/campaigns' \  -H 'Content-Type: application/json' \  -d '{  "channel": "push",  "recipients": [    {      "external_user_id": "string",      "content": {        "push": {}      }    }  ]}'
Example Response
{  "campaign_id": "0a1b2c3d-4e5f-6789-abcd-ef0123456789",  "channel": "push",  "status": "queued",  "message_count": 2,  "messages": [    {      "message_id": "11111111-1111-4111-8111-111111111111",      "external_user_id": "user_a",      "status": "processing",      "delivery_count": 1    },    {      "message_id": "22222222-2222-4222-8222-222222222222",      "external_user_id": "user_b",      "status": "processing",      "delivery_count": 1    }  ]}