Automated Campaigns

Endpoints for automated campaigns.

Endpoint Description
GET v3/automatedcampaigns Gets a list of automated campaigns.
GET v3/automatedcampaigns/{automatedCampaignId} Gets an automated campaign.
GET v3/automatedcampaigns/{automatedCampaignId}/events Gets a list of events for an automated campaign.
GET v3/automatedcampaigns/{automatedCampaignId}/report Gets an automated campaign report.
GET v3/automatedcampaigns/{automatedCampaignId}/steps Gets a list of steps for an automated campaign.
GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId} Gets an automated campaign step.
GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events Gets a list of events for an automated campaign step.
GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/report Gets an automated campaign step report.
GET v3/automatedcampaigns/statuses Gets a list of automated campaign statuses.
GET v3/automatedcampaigns/steptypes Gets a list of automated campaign step types.

Content

Endpoints for content.

Endpoint Description
GET v3/content/articles Gets a list of articles.
GET v3/content/articles/infographic/{articleId} Gets an infographic article.
GET v3/content/articles/interactive/{articleId} Gets an interactive article.
GET v3/content/articles/mediaessay/{articleId} Gets a media essay article.
GET v3/content/articles/slideshow/{articleId} Gets a slideshow article.
GET v3/content/articles/text/{articleId} Gets a text article.
GET v3/content/articles/video/{articleId} Gets a video article.

Events

Endpoints for events.

Endpoint Description
GET v3/events/types Gets a list of event types.

Lists

Endpoints for lists.

Endpoint Description
DELETE v3/lists/{listId} Deletes a list.
DELETE v3/lists/{listId}/subscribers/{subscriberId} Removes a subscriber from a list.
GET v3/lists Gets a list of lists.
GET v3/lists/{listId} Gets a list.
GET v3/lists/{listId}/subscribers Gets a list of list subscribers; relationships between a list and subscribers.
GET v3/lists/{listId}/subscribers/{subscriberId} Gets a list subscriber; a relationship between a list and a subscriber.
POST v3/lists Creates a new list.
POST v3/lists/{listId}/subscribers Adds a subscriber to a list.
PUT v3/lists/{listId} Updates an existing list.

Standard Campaigns

Endpoints for standard campaigns.

Endpoint Description
GET v3/standardcampaigns Gets a list of standard campaigns.
GET v3/standardcampaigns/{standardCampaignId} Gets a standard campaign.
GET v3/standardcampaigns/{standardCampaignId}/events Gets a list of events for a standard campaign.
GET v3/standardcampaigns/{standardCampaignId}/report Gets a standard campaign report.
GET v3/standardcampaigns/{standardCampaignId}/sends Gets a list of standard campaign sends for a standard campaign.
GET v3/standardcampaigns/{standardCampaignId}/sends/{standardCampaignSendId} Gets a standard campaign send for a standard campaign.
GET v3/standardcampaigns/{standardCampaignId}/sends/{standardCampaignSendId}/events Gets a list of events for a standard campaign send.
GET v3/standardcampaigns/{standardCampaignId}/sends/{standardCampaignSendId}/report Gets a standard campaign send report.
GET v3/standardcampaigns/{standardCampaignId}/sends/{standardCampaignSendId}/report/advanced Gets a standard campaign send advanced report.
GET v3/standardcampaigns/{standardCampaignId}/sends/{standardCampaignSendId}/subscriptions Gets subscriptions of a campaign send.

Subscribers

Endpoints for subscribers.

Endpoint Description
DELETE v3/subscribers/{subscriberId}/automatedcampaigns/{automatedCampaignId} Removes a subscriber from an automated campaign.
DELETE v3/subscribers/{subscriberId}/subscriptions/email/{subscriptionId} Removes a subscriber from an email subscription.
DELETE v3/subscribers/{subscriberId}/subscriptions/fax/{subscriptionId} Removes a subscriber from a fax subscription.
DELETE v3/subscribers/{subscriberId}/subscriptions/sms/{subscriptionId} Removes a subscriber from an SMS subscription.
DELETE v3/subscribers/email/{subscriberId} Removes a subscriber from receiving emails.
DELETE v3/subscribers/fax/{subscriberId} Removes a subscriber from receiving faxes.
DELETE v3/subscribers/sms/{subscriberId} Removes a subscriber from receiving SMS messages.
GET v3/subscribers Gets a list of subscribers.
GET v3/subscribers/{subscriberId} Gets a subscriber.
GET v3/subscribers/bykey/{subscriberKey} Gets a subscriber.
GET v3/subscribers/{subscriberId}/events Gets a list of events for a subscriber.
POST v3/subscribers Creates a new subscriber.
POST v3/subscribers/{subscriberId}/automatedcampaigns Adds a subscriber to an automated campaign.
POST v3/subscribers/{subscriberId}/subscriptions/email Adds a subscriber to an email subscription.
POST v3/subscribers/{subscriberId}/subscriptions/fax Adds a subscriber to a fax subscription.
POST v3/subscribers/{subscriberId}/subscriptions/sms Adds a subscriber to an SMS subscription.
POST v3/subscribers/email Adds a subscriber to receive emails.
POST v3/subscribers/fax Adds a subscriber to receive faxes.
POST v3/subscribers/sms Adds a subscriber to receive SMS messages.
PUT v3/subscribers/{subscriberId} Updates an existing subscriber. Requires all fields in the request body to be sent; fields not sent in the request body will be cleared out.
PUT v3/subscribers/{subscriberId}/activate Activates (or reactivates) a subscriber.
PUT v3/subscribers/{subscriberId}/deactivate Deactivates a subscriber.

Subscriptions

Endpoints for subscriptions.

Endpoint Description
GET v3/subscriptions Gets a list of subscriptions.
GET v3/subscriptions/{subscriptionId} Gets a subscription.