Create campaign

Creates a campaign for the authenticated account and returns it in the same UUID-only shape as get_campaign (HTTP 201). campaign_type must be one of the supported type keys (see the enum). eds_uuid (the sending domain / email delivery system) and footer_uuid are required and must reference resources owned by the account -- they become the campaign's defaults and propagate to emails added to its sequences. List the available delivery systems via GET /rest/eds/get_eds and footers via GET /rest/footers/get_footers. After creating the campaign, add sequences to it with create_sequence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 2 and 50

Display name for the campaign.

string
enum
required

The campaign type. Must be one of the supported type keys.

string
length ≤ 255

Optional free-text description.

uuid
required

UUID of the email delivery system (sending domain) to set as the campaign default. Must belong to the account. Fetch options from GET /rest/eds/get_eds.

uuid
required
Responses

401

Missing or invalid bearer token.

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