Campaigns - Send

Send a campaign to a list of phone numbers, now or at a scheduled time. Up to 1000 contacts per request; duplicates are removed. The send is queued and processed in the background. Rate limit: 10 requests per second.

POST /api/campaigns/send

Campaigns - Send

cURL

curl --request POST \
  --url https://getsimio.app/api/campaigns/send \
  --header 'Content-Type: application/json' \
  --header 'simio-api-key: <api-key>' \
  --data '
{
  "campaign_id": 123,
  "contacts": [
    "33612345678",
    "33698765432"
  ],
  "is_forced": false,
  "scheduled_at": "2025-09-01T09:00:00Z"
}
'

202

{
  "batch_id": "1759842000000",
  "contacts": 2,
  "status": "accepted"
}

Authorizations

simio-api-key · string · header · required

Company API key, created in Settings > Integrations & developers > Credentials.

Body

application/json

campaign_id · integer · required

ID of the campaign to send.

Example:

123

contacts · string[] · required

Recipient phone numbers in E.164 format (up to 1000 per request; duplicates are removed).

Pattern: ^\+?[1-9]\d{6,14}$

Example:

["33612345678", "33698765432"]

is_forced · boolean · default: false

Bypass the account's delivery-hours and opt-out checks.

Example:

false

scheduled_at · string | null

ISO 8601 datetime to schedule the send for; omit to send immediately.

Maximum string length: 64

Example:

"2025-09-01T09:00:00Z"

Response

202

application/json

Successful Response

batch_id · string · required

Identifier of this send batch.

Example:

"1759842000000"

contacts · integer · required

Number of contacts the send was queued for.

Example:

2

status · string · required

Always accepted: the send is queued and processed in the background.

Allowed value: "accepted"

Example:

"accepted"