Skip to main content
POST
Trigger an API campaign send

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string
required

Body

application/json

Request body for triggering an API campaign send.

recipients
object[]
required

List of recipients to send to. Each entry must include either a handle (delivery address) or an id (Personalization API based profile ID).

Required array length: 1 - 100 elements

A single send target. Provide either handle (inline delivery address) or id (Personalization API profile ID), but not both.

properties
object

Shared personalization properties applied to all recipients. Keys must match the variable names shown in the message editor. Per-recipient properties take precedence when a key appears in both.

draft
boolean
default:false

When true, sends the campaign even if it has not been activated. Intended for test sends against draft campaigns only.

Response

Ok

Response body for a campaign trigger request. Results are returned in the same order as the input recipients array.

results
object[]
required

Per-recipient outcomes. Accepted recipients are queued for delivery; rejected recipients were not sent.