# Zoho Campaigns

> Connect Zoho Campaigns to automate mailing lists, subscribers and campaigns.

App · 18 actions. Web page: https://docs.lodol.com/docs/integrations/zoho-campaigns

## Actions

### Add contact to do-not-mail

Adds a contact, identified by email, to the account's do-not-mail registry so no campaigns are sent to them.

**Inputs**

- Contactinfo (`contactinfo`, object, required): Contactinfo for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Add contacts to mailing list

Adds several email addresses to a mailing list at once, by its list key.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Emailids (`emailids`, list, required): Emailids for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Count list contacts

Counts the contacts in a mailing list by its list key, optionally only those with a given status such as active, unsubscribed or bounced.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Status (`status`, text): Status for this request. One of: `active`, `unsub`, `bounce`, `spam`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create contact field

Creates a new custom contact field with a name, type and optional length.

**Inputs**

- Fieldname (`fieldname`, text, required): Fieldname for this request.
- Fieldtype (`fieldtype`, text, required): Fieldtype for this request. One of: `Text`, `Integer`, `Phone`, `Date`, `Picklist`, `Email`, `Checkbox`, `LongInteger`, `URL`, `textarea`, and 5 more.
- Fieldlength (`fieldlength`, number): Fieldlength for this request. At least 1.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create draft campaign

Creates a draft email campaign with a name, sender, subject and the mailing lists to send to, optionally loading content from a URL. Returns the new campaign's key.

**Inputs**

- Campaignname (`campaignname`, text, required): Campaignname for this request.
- From email (`from_email`, text, required): From email for this request.
- From name (`from_name`, text): From name for this request.
- Subject (`subject`, text, required): Subject for this request.
- Content url (`content_url`, text): Content url for this request.
- List details (`list_details`, object, required): List details for this request.
- Topic id (`topic_id`, text): Topic id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create mailing list and contacts

Creates a new mailing list with a name and signup form, and adds the email addresses you give to it. Returns the new list's key.

**Inputs**

- Listname (`listname`, text, required): Listname for this request.
- Signupform (`signupform`, text, required): Signupform for this request. One of: `public`, `private`.
- Emailids (`emailids`, list, required): Emailids for this request.
- Listdescription (`listdescription`, text): Listdescription for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete mailing list

Deletes a mailing list by its list key, and optionally the contacts in it too.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Deletecontacts (`deletecontacts`, text, required): Deletecontacts for this request. One of: `off`, `on`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get campaign details

Gets a campaign by its campaign key, including its name, subject, sender, status and the lists it goes to.

**Inputs**

- Campaignkey (`campaignkey`, text, required): Campaignkey for this request.
- Campaigntype (`campaigntype`, text): Campaigntype for this request. One of: `normal`, `abtesting`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get mailing list details

Gets a mailing list's details by its list key, including its contact counts and the campaigns sent or scheduled to it.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Filtertype (`filtertype`, text): Filtertype for this request. One of: `sentcampaigns`, `scheduledcampaigns`, `recentcampaigns`.
- Fromindex (`fromindex`, number): Fromindex for this request. At least 1.
- Range (`range`, number): Range for this request. From 1 to 200.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get segment details

Gets a segment of a mailing list by its list key and segment ID, including its name and conditions.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Cvid (`cvid`, number, required): Cvid for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List contact fields

Lists all the contact fields in your account, standard and custom, with each field's name and type.

**Inputs**: None.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List contacts

Lists the contacts in a mailing list by its list key, optionally filtered by status such as active, unsubscribed or bounced, a range at a time.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Status (`status`, text): Status for this request. One of: `active`, `recent`, `mostrecent`, `unsub`, `bounce`.
- Fromindex (`fromindex`, number): Fromindex for this request. At least 1.
- Range (`range`, number): Range for this request. From 1 to 200.
- Sort (`sort`, text): Sort for this request. One of: `asc`, `desc`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List mailing lists

Lists the mailing lists in your Zoho Campaigns account, a range at a time and sorted if you like. Returns each list's name and list key.

**Inputs**

- Fromindex (`fromindex`, number): Fromindex for this request. At least 1.
- Range (`range`, number): Range for this request. From 1 to 200.
- Sort (`sort`, text): Sort for this request. One of: `asc`, `desc`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List segment contacts

Lists the contacts that belong to a segment, by its segment ID.

**Inputs**

- Cvid (`cvid`, number, required): Cvid for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List topics

Lists the topics in your account that contacts can subscribe to, with each topic's ID and name.

**Inputs**

- Details (`details`, object): Details for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Subscribe or update contact

Adds a contact to a mailing list by its list key, or updates the contact's details if already there, optionally under a topic.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Contactinfo (`contactinfo`, object, required): Contactinfo for this request.
- Source (`source`, text): Source for this request.
- Topic id (`topic_id`, text): Topic id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Unsubscribe contact

Unsubscribes a contact, identified by email, from a mailing list by its list key.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Contactinfo (`contactinfo`, object, required): Contactinfo for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Update mailing list

Renames a mailing list by its list key and sets which signup form it uses.

**Inputs**

- Mailing list (`listkey`, text, required): Listkey for this request.
- Newlistname (`newlistname`, text, required): Newlistname for this request.
- Signupform (`signupform`, text, required): Signupform for this request. One of: `public`, `private`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```
