Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

A ManyPI API key (mpi_...) from the profile menu → API Access in the dashboard, or an OAuth 2.1 access token obtained through the MCP consent flow.

Body

application/json
name
string
required
Maximum string length: 120
sequence_id
string<uuid>
smtp_config_id
string<uuid>

An inbox id from GET /api/outreach/inboxes. Use smtp_config_ids for several.

smtp_config_ids
string<uuid>[]

Send from several inboxes. The first is the primary.

Maximum array length: 25
brand_id
string<uuid>

Create it in this brand rather than your current one.

status
enum<string>

Start paused or as a draft instead of active.

Available options:
paused,
draft
reply_to
string<email>
daily_limit
integer

Never exceeds the inbox's own cap.

Required range: 1 <= x <= 2000
schedule_enabled
boolean
send_days
integer[]

Defaults to Mon–Fri.

Required range: 0 <= x <= 6
send_from
string

Local time, HH:MM. An invalid value is dropped without an error.

send_to
string

Local time, HH:MM. An invalid value is dropped without an error.

timezone
string

An IANA timezone such as Europe/Berlin. An unknown zone is dropped without an error.

track_opens
boolean
priority
integer
default:5

Higher wins the next paced slot when campaigns share an inbox. Values outside 1 to 10 are clamped, not rejected.

Required range: 1 <= x <= 10
inbox_strategy
enum<string>
Available options:
single,
rotate,
round_robin,
provider_match
include_unsubscribe
boolean
default:true

Add an unsubscribe link to each email.

send_in_lead_timezone
boolean

Apply the send window on each lead's own clock.

unsubscribe_header
boolean

Send one-click unsubscribe headers.

track_clicks
boolean

Add UTM tags to links.

The utm_campaign value for tagged links.

Response

The created campaign.

campaign
object