Zoho Campaigns
App · 18 actions
Connect Zoho Campaigns to automate mailing lists, subscribers and campaigns.
Actions
| Action | What it does |
|---|---|
| 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. |
| Add contacts to mailing list | Adds several email addresses to a mailing list at once, by its list key. |
| 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. |
| Create contact field | Creates a new custom contact field with a name, type and optional length. |
| 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. |
| 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. |
| Delete mailing list | Deletes a mailing list by its list key, and optionally the contacts in it too. |
| Get campaign details | Gets a campaign by its campaign key, including its name, subject, sender, status and the lists it goes to. |
| 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. |
| Get segment details | Gets a segment of a mailing list by its list key and segment ID, including its name and conditions. |
| List contact fields | Lists all the contact fields in your account, standard and custom, with each field's name and type. |
| 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. |
| List mailing lists | Lists the mailing lists in your Zoho Campaigns account, a range at a time and sorted if you like. |
| List segment contacts | Lists the contacts that belong to a segment, by its segment ID. |
| List topics | Lists the topics in your account that contacts can subscribe to, with each topic's ID and name. |
| 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. |
| Unsubscribe contact | Unsubscribes a contact, identified by email, from a mailing list by its list key. |
| Update mailing list | Renames a mailing list by its list key and sets which signup form it uses. |
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
contactinfoobjectRequired - Contactinfo for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Emailids
emailidslistRequired - Emailids for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Status
statustext - Status for this request.One of:
active,unsub,bounce,spam.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
fieldnametextRequired - Fieldname for this request.
- Fieldtype
fieldtypetextRequired - Fieldtype for this request.One of:
Text,Integer,Phone,Date,Picklist,Email,Checkbox,LongInteger,URL,textarea, and 5 more. - Fieldlength
fieldlengthnumber - Fieldlength for this request.At least 1.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
campaignnametextRequired - Campaignname for this request.
- From email
from_emailtextRequired - From email for this request.
- From name
from_nametext - From name for this request.
- Subject
subjecttextRequired - Subject for this request.
- Content url
content_urltext - Content url for this request.
- List details
list_detailsobjectRequired - List details for this request.
- Topic id
topic_idtext - Topic id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listnametextRequired - Listname for this request.
- Signupform
signupformtextRequired - Signupform for this request.One of:
public,private. - Emailids
emailidslistRequired - Emailids for this request.
- Listdescription
listdescriptiontext - Listdescription for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Deletecontacts
deletecontactstextRequired - Deletecontacts for this request.One of:
off,on.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
campaignkeytextRequired - Campaignkey for this request.
- Campaigntype
campaigntypetext - Campaigntype for this request.One of:
normal,abtesting.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Filtertype
filtertypetext - Filtertype for this request.One of:
sentcampaigns,scheduledcampaigns,recentcampaigns. - Fromindex
fromindexnumber - Fromindex for this request.At least 1.
- Range
rangenumber - Range for this request.From 1 to 200.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Cvid
cvidnumberRequired - Cvid for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Status
statustext - Status for this request.One of:
active,recent,mostrecent,unsub,bounce. - Fromindex
fromindexnumber - Fromindex for this request.At least 1.
- Range
rangenumber - Range for this request.From 1 to 200.
- Sort
sorttext - Sort for this request.One of:
asc,desc.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
fromindexnumber - Fromindex for this request.At least 1.
- Range
rangenumber - Range for this request.From 1 to 200.
- Sort
sorttext - Sort for this request.One of:
asc,desc.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}List segment contacts
Lists the contacts that belong to a segment, by its segment ID.
Inputs
- Cvid
cvidnumberRequired - Cvid for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
detailsobject - Details for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Contactinfo
contactinfoobjectRequired - Contactinfo for this request.
- Source
sourcetext - Source for this request.
- Topic id
topic_idtext - Topic id for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Contactinfo
contactinfoobjectRequired - Contactinfo for this request.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"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
listkeytextRequired - Listkey for this request.
- Newlistname
newlistnametextRequired - Newlistname for this request.
- Signupform
signupformtextRequired - Signupform for this request.One of:
public,private.
Outputs
dataobject- The service response, including all records and metadata.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation value for the next page.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}