Skip to main content
POST
Start Engage campaign (REST only)

Authorizations

Authorization
string
header
required

Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.

Scopes

engage.queue:send

Send approved engagement messages and start campaigns.

Headers

X-Organization-Id
string<uuid>

Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Idempotency-Key
string
required

Unique client-generated key for safe retries. Replaying the same key with the same payload returns the stored result; reuse with a different payload returns 409.

Required string length: 1 - 255

Path Parameters

campaignId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Query Parameters

organizationId
string<uuid>

Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Body

application/json
senderUserId
string<uuid>

Organization user to send as. Required for client-credential tokens; user tokens default to the authenticated user.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
accountId
string<uuid>
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
to
object[]
Maximum array length: 500
engageListId
string<uuid>
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
sendAt
string<date-time>

Schedule as a UTC instant. Cannot be combined with localDate, localTime, timeZone or occurrence. Omit every schedule field to send immediately.

localDate
string

Schedule as a local date (YYYY-MM-DD) in timeZone. Requires localTime and timeZone; the server computes the UTC instant.

Pattern: ^\d{4}-\d{2}-\d{2}$
localTime
string

Local 24-hour time (HH:mm) in timeZone. Requires localDate and timeZone.

Pattern: ^\d{2}:\d{2}$
timeZone
string

IANA time zone name the local date and time are in, such as "Europe/Madrid". It is stored with the schedule. An unknown name returns 422 with details.code invalid_time_zone.

Required string length: 1 - 64
occurrence
string

Either "earlier" or "later". Required when the local time occurs twice because clocks go back for daylight saving (otherwise 422 with details.code send_at_ambiguous_local_time); ignored for other times. Any other value returns 422 with details.code invalid_send_at_occurrence. A local time skipped when clocks go forward is rejected with details.code send_at_nonexistent_local_time.

needsApproval
boolean

Response

Enrollment accepted.

enrollmentJobId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
campaignId
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed