Campaign Manager API Calls

Note: The below article uses examples of accessing the Decipher API from a Unix system that has the Beacon library package installed. Click here to learn more about accessing the Decipher REST API.

The Decipher API allows you to manage your survey's email campaigns using the same principles as the Campaign Manager.

You can use the following API calls to upload and review recipient lists for email campaigns. Click any call name to view more information.

Call Name	Description
Campaign Manager	Retrieves information for any e-mail campaigns created in the specified survey.
Create Campaign	Creates an individual email campaign. Creating a campaign using this endpoint allows for new email sends to be scheduled while other sends are still pending.
Get Campaign	Retrieves an individual email campaign. Returns the following properties for the campaign: Campaign Name Reply To From Name List Size Date From Address Campaign ID Subject
Edit Campaign	Changes the following properties for an individual email campaign: name fromName fromAddress replyTo subject link
Get Invite	Retrieves the body content for the email invite that was created for an email campaign.
Edit Invite	Edits the body content of an email invite that was created for an email campaign.
Campaign List	Uploads a recipient list for an individual email campaign.
Get Lists	Downloads the recipient list that was uploaded for an individual email campaign.
Replace Lists	Uploads a recipient list for use in email campaigns. Note: Recipient lists are not automatically shareable with other email campaigns for the same project. You must specify whether to share a list with other campaigns.
Get a Send	Retrieves information about a single email send for an individual email campaign.
Get Sends	Retrieves information about all email sends for an individual email campaign.
Status List	Retrieves a list of all the recipients for a successful email send. Will also return a list that includes throttled and suppressed recipients, (i.e., those who would have received the email but did not because either the sender or the system excluded them).
Create Suppression List	Creates a list of email addresses to be suppressed for one or more email sends.
Get Suppression List	Retrieves an individual email suppression list.
Get Suppression Lists	Retrieves all the email suppression lists for the specified project.
Create a Send	Schedules an email send for a campaign to go out at the specified time / date.
Cancel a Send	Cancels a previously scheduled email send.