Skip to main content
POST
Launch a campaign

Authorizations

Authorization
string
header
required

API key for authentication

Headers

Idempotency-Key
string

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

campaignId
string
required

The ID of the campaign.

Required string length: 40

Body

application/json
scheduledAt
string<date-time>

When to send: an ISO date and time with a timezone offset or Z, at least a minute ahead. Omit to send now.

Maximum string length: 64
Example:

"2030-01-15T09:00:00+02:00"

Response

The campaign, sending or scheduled.

data
object
required

A campaign: one or more emails, each a step, sent to a list of people or companies.

Example:
deprecations
string[]
Example: