This page will walk you through creating a campaign from the API.

​
Creating a Campaign

Send a POST request to /api/campaigns. You must pass 1 body parameter, name, which corresponds to the name of the campaign you wish to create. If successful, you will receive a a 200 OK with the campaign ID as part of the response.

​
Campaign Settings

You can get the ID for a campaign using the UI by navigating to the campaign, clicking on the Actions dropdown, and then clicking Copy ID for API.Alternatively, campaign IDs can be acquired with a GET request to /api/campaigns.
Each campaign has individual settings that can be changed. You can view the settings with a GET request to /api/campaigns/{id} where {id} is the campaign ID. If you need to change the settings, send a POST request to /api/campaigns/{id}/update where {id} is the campaign ID.

​
Campaign Schedule

If you have created a schedule for a campaign in the past, you can re-use it provided you’ve saved it as a template. If you have a schedule template you wish to use: Get the schedule ID by sending a GET request to /api/campaigns/schedule/templates. Once you’ve acquired the ID, send a POST to /api/campaigns/{campaign_id}/create-schedule-from-template. The request requires 1 body field, schedule_id, which is the ID of the schedule you want to use. If you don’t have a schedule template you wish to use: If you don’t have any templates, or wish to create a new one, send a POST request to /api/campaigns/{campaign_id}/schedule.

​
Campaign Sequence

The sequence of the campaign is the emails that will be sent out. To create your sequence, send a POST request to /api/campaigns/{campaign_id}/sequence-steps. The request can take only 2 fields in the body JSON. title and sequence_steps. title is a string, and sequence_steps is an array that contains the following fields:
The request will look like the following example:

​
Launching Campaign

After creating a campaign, updating its settings, creating or choosing a schedule, and creating a sequence, you have completed all the necessary steps in creating a campaign. You can send these requests to check the details of a campaign:
  • GET /api/campaigns/{campaign_id}: retrieves the campaign you created and its settings.
  • GET /api/campaigns/{campaign_id}/schedule: retreives the campaign schedule.
  • GET /api/campaigns/{campaign_id}/sequence-steps: retrieves the campaign sequences steps.
Once you’re ready to launch your campaign, send a PATCH request to /api/campaigns/{campaign_id}/resume. You can pause the campaign by sending a PATCH request to /api/campaigns/{campaign_id}/pause.