Skip to main content
POST
Trigger a campaign send for one user

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

campaignId
integer
required

Numeric campaign identifier.

Example:

24

Body

application/json

Fire a trigger campaign for a single user.

user
object
required

Identifies the user for a trigger campaign send. Additional custom attributes may be included.

event
object
required

Event payload that drives the trigger send. Available to template Handlebars as {{event}}. Include source + source_company_id, or company_id, to render {{company}} from an active CRM company association for this user.

Response

The trigger was queued.

Confirmation that the trigger was queued.

success
boolean
required