Send or schedule email campaign

Send an email campaign immediately or schedule it for later delivery.

You can specify the audience in two ways:

  1. audienceIds - Array of customer segment IDs
  2. criteria - Ad-hoc audience conditions

Optionally provide scheduledAt to schedule the campaign for future delivery.

Rate limited to 10 sends per minute per organization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Campaign ID

Body Params
audienceIds
array of strings

Customer segment IDs to send to

audienceIds
criteria
object

Ad-hoc audience conditions

string

Idempotency key to prevent duplicate sends

boolean

Send to customers across all apps

date-time

ISO date-time to schedule the campaign. If provided, the campaign will be sent at this time instead of immediately.

Responses

400

Validation error

404

Campaign not found

429

Rate limit exceeded

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json