# Campaign Monitor

> Manage subscribers and read email lists, segments, campaigns and performance reports.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/campaign-monitor

## Actions

### 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_id`, text, required): Subscriber list.
- Email (`email`, text, required): Email address to subscribe.
- Name (`name`, text): Subscriber’s name.
- Consent to track (`consent_to_track`, text, required): Permission to track opens and clicks. For a new subscriber, Unchanged can grant consent. One of: `Yes`, `No`, `Unchanged`.

**Outputs**

- `data` (text): The response from Campaign Monitor.

**Example output**

```json
{
  "data": "example"
}
```

### Get campaign lists and segments

Read the lists and segments targeted by a campaign.

**Inputs**

- Campaign ID (`campaign_id`, text, required): Campaign ID from List sent campaigns.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {}
}
```

### Get campaign summary

Read performance totals for a sent campaign.

**Inputs**

- Campaign ID (`campaign_id`, text, required): Campaign ID from List sent campaigns.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {}
}
```

### Get client

Read a client’s details.

**Inputs**

- Client (`client_id`, text, required): Campaign Monitor client.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {}
}
```

### Get subscriber

Find a subscriber by email within a list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.
- Email (`email`, text, required): Subscriber’s email address.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {
    "Date": "example",
    "EmailAddress": "example",
    "Name": "example",
    "State": "example"
  }
}
```

### Get subscriber list

Read a subscriber list’s name and settings.

**Inputs**

- List (`list_id`, text, required): Subscriber list.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {
    "ListID": "example",
    "Title": "example"
  }
}
```

### Get subscriber list statistics

Read subscriber counts for a list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {}
}
```

### List active subscribers

Read a page of active subscribers from a list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.
- Date (`date`, date): Include subscribers who entered this state on or after this date.
- Page (`page`, number): Page number to retrieve. At least 1.
- Page size (`page_size`, number): Subscribers per page. From 1 to 1000.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "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_id`, text, required): Subscriber list.
- Date (`date`, date): Include subscribers who entered this state on or after this date.
- Page (`page`, number): Page number to retrieve. At least 1.
- Page size (`page_size`, number): Subscribers per page. From 1 to 1000.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "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**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "ClientID": "example",
      "Name": "example"
    }
  ]
}
```

### List deleted subscribers

Read a page of deleted subscribers from a list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.
- Date (`date`, date): Include subscribers who entered this state on or after this date.
- Page (`page`, number): Page number to retrieve. At least 1.
- Page size (`page_size`, number): Subscribers per page. From 1 to 1000.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "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_id`, text, required): Campaign Monitor client.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "CampaignID": "example",
      "Name": "example",
      "Subject": "example"
    }
  ]
}
```

### List email templates

List the email templates available to a client.

**Inputs**

- Client (`client_id`, text, required): Campaign Monitor client.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "Name": "example",
      "TemplateID": "example"
    }
  ]
}
```

### List scheduled campaigns

List campaigns scheduled by a client.

**Inputs**

- Client (`client_id`, text, required): Campaign Monitor client.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "CampaignID": "example",
      "Name": "example",
      "Subject": "example"
    }
  ]
}
```

### List segments

List the segments configured for a subscriber list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "SegmentID": "example",
      "Title": "example"
    }
  ]
}
```

### List sent campaigns

List campaigns already sent by a client.

**Inputs**

- Client (`client_id`, text, required): Campaign Monitor client.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "CampaignID": "example",
      "Name": "example",
      "Subject": "example"
    }
  ]
}
```

### List subscriber custom fields

List the custom fields configured for a list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {}
  ]
}
```

### List subscriber lists

List a client’s subscriber lists.

**Inputs**

- Client (`client_id`, text, required): Campaign Monitor client.

**Outputs**

- `data` (list): The response from Campaign Monitor.

**Example output**

```json
{
  "data": [
    {
      "ListID": "example",
      "Name": "example"
    }
  ]
}
```

### List unsubscribed subscribers

Read a page of unsubscribed subscribers from a list.

**Inputs**

- List (`list_id`, text, required): Subscriber list.
- Date (`date`, date): Include subscribers who entered this state on or after this date.
- Page (`page`, number): Page number to retrieve. At least 1.
- Page size (`page_size`, number): Subscribers per page. From 1 to 1000.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "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_id`, text, required): Subscriber list.
- Email (`email`, text, required): Email address to unsubscribe.

**Outputs**

- `data` (object): The response from Campaign Monitor.

**Example output**

```json
{
  "data": {}
}
```
