Campaign Monitor
App · 20 actions
Manage subscribers and read email lists, segments, campaigns and performance reports.
Actions
| Action | What it does |
|---|---|
| Add or update subscriber | Add an email address or update the existing subscriber. |
| Get campaign lists and segments | Read the lists and segments targeted by a campaign. |
| Get campaign summary | Read performance totals for a sent campaign. |
| Get client | Read a client’s details. |
| Get subscriber | Find a subscriber by email within a list. |
| Get subscriber list | Read a subscriber list’s name and settings. |
| Get subscriber list statistics | Read subscriber counts for a list. |
| List active subscribers | Read a page of active subscribers from a list. |
| List bounced subscribers | Read a page of bounced subscribers from a list. |
| List clients | List the clients accessible to this API key. |
| List deleted subscribers | Read a page of deleted subscribers from a list. |
| List draft campaigns | List unsent campaign drafts for a client. |
| List email templates | List the email templates available to a client. |
| List scheduled campaigns | List campaigns scheduled by a client. |
| List segments | List the segments configured for a subscriber list. |
| List sent campaigns | List campaigns already sent by a client. |
| List subscriber custom fields | List the custom fields configured for a list. |
| List subscriber lists | List a client’s subscriber lists. |
| List unsubscribed subscribers | Read a page of unsubscribed subscribers from a list. |
| Unsubscribe email | Unsubscribe an email address from a list. |
Add or update subscriber
Add an email address or update the existing subscriber. Enter the address only when you have permission to subscribe it.
Inputs
- List
list_idtextRequired - Subscriber list.
- Email
emailtextRequired - Email address to subscribe.
- Name
nametext - Subscriber’s name.
- Consent to track
consent_to_tracktextRequired - Permission to track opens and clicks. For a new subscriber, Unchanged can grant consent.One of:
Yes,No,Unchanged.
Outputs
datatext- The response from Campaign Monitor.
Example output
{
"data": "example"
}Get campaign lists and segments
Read the lists and segments targeted by a campaign.
Inputs
- Campaign ID
campaign_idtextRequired - Campaign ID from List sent campaigns.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {}
}Get campaign summary
Read performance totals for a sent campaign.
Inputs
- Campaign ID
campaign_idtextRequired - Campaign ID from List sent campaigns.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {}
}Get client
Read a client’s details.
Inputs
- Client
client_idtextRequired - Campaign Monitor client.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {}
}Get subscriber
Find a subscriber by email within a list.
Inputs
- List
list_idtextRequired - Subscriber list.
- Email
emailtextRequired - Subscriber’s email address.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {
"Date": "example",
"EmailAddress": "example",
"Name": "example",
"State": "example"
}
}Get subscriber list
Read a subscriber list’s name and settings.
Inputs
- List
list_idtextRequired - Subscriber list.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {
"ListID": "example",
"Title": "example"
}
}Get subscriber list statistics
Read subscriber counts for a list.
Inputs
- List
list_idtextRequired - Subscriber list.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {}
}List active subscribers
Read a page of active subscribers from a list.
Inputs
- List
list_idtextRequired - Subscriber list.
- Date
datedate - Include subscribers who entered this state on or after this date.
- Page
pagenumber - Page number to retrieve.At least 1.
- Page size
page_sizenumber - Subscribers per page.From 1 to 1000.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {
"NumberOfPages": 1,
"PageNumber": 1,
"Results": [
{
"Date": "example",
"EmailAddress": "example",
"Name": "example",
"State": "example"
}
],
"TotalNumberOfRecords": 1
}
}List bounced subscribers
Read a page of bounced subscribers from a list.
Inputs
- List
list_idtextRequired - Subscriber list.
- Date
datedate - Include subscribers who entered this state on or after this date.
- Page
pagenumber - Page number to retrieve.At least 1.
- Page size
page_sizenumber - Subscribers per page.From 1 to 1000.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {
"NumberOfPages": 1,
"PageNumber": 1,
"Results": [
{
"Date": "example",
"EmailAddress": "example",
"Name": "example",
"State": "example"
}
],
"TotalNumberOfRecords": 1
}
}List clients
List the clients accessible to this API key.
Inputs
None.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"ClientID": "example",
"Name": "example"
}
]
}List deleted subscribers
Read a page of deleted subscribers from a list.
Inputs
- List
list_idtextRequired - Subscriber list.
- Date
datedate - Include subscribers who entered this state on or after this date.
- Page
pagenumber - Page number to retrieve.At least 1.
- Page size
page_sizenumber - Subscribers per page.From 1 to 1000.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {
"NumberOfPages": 1,
"PageNumber": 1,
"Results": [
{
"Date": "example",
"EmailAddress": "example",
"Name": "example",
"State": "example"
}
],
"TotalNumberOfRecords": 1
}
}List draft campaigns
List unsent campaign drafts for a client.
Inputs
- Client
client_idtextRequired - Campaign Monitor client.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"CampaignID": "example",
"Name": "example",
"Subject": "example"
}
]
}List email templates
List the email templates available to a client.
Inputs
- Client
client_idtextRequired - Campaign Monitor client.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"Name": "example",
"TemplateID": "example"
}
]
}List scheduled campaigns
List campaigns scheduled by a client.
Inputs
- Client
client_idtextRequired - Campaign Monitor client.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"CampaignID": "example",
"Name": "example",
"Subject": "example"
}
]
}List segments
List the segments configured for a subscriber list.
Inputs
- List
list_idtextRequired - Subscriber list.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"SegmentID": "example",
"Title": "example"
}
]
}List sent campaigns
List campaigns already sent by a client.
Inputs
- Client
client_idtextRequired - Campaign Monitor client.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"CampaignID": "example",
"Name": "example",
"Subject": "example"
}
]
}List subscriber custom fields
List the custom fields configured for a list.
Inputs
- List
list_idtextRequired - Subscriber list.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{}
]
}List subscriber lists
List a client’s subscriber lists.
Inputs
- Client
client_idtextRequired - Campaign Monitor client.
Outputs
datalist- The response from Campaign Monitor.
Example output
{
"data": [
{
"ListID": "example",
"Name": "example"
}
]
}List unsubscribed subscribers
Read a page of unsubscribed subscribers from a list.
Inputs
- List
list_idtextRequired - Subscriber list.
- Date
datedate - Include subscribers who entered this state on or after this date.
- Page
pagenumber - Page number to retrieve.At least 1.
- Page size
page_sizenumber - Subscribers per page.From 1 to 1000.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {
"NumberOfPages": 1,
"PageNumber": 1,
"Results": [
{
"Date": "example",
"EmailAddress": "example",
"Name": "example",
"State": "example"
}
],
"TotalNumberOfRecords": 1
}
}Unsubscribe email
Unsubscribe an email address from a list.
Inputs
- List
list_idtextRequired - Subscriber list.
- Email
emailtextRequired - Email address to unsubscribe.
Outputs
dataobject- The response from Campaign Monitor.
Example output
{
"data": {}
}