Zoho Campaigns

App · 18 actions

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

Actions

ActionWhat it does
Add contact to do-not-mailAdds a contact, identified by email, to the account's do-not-mail registry so no campaigns are sent to them.
Add contacts to mailing listAdds several email addresses to a mailing list at once, by its list key.
Count list contactsCounts 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 fieldCreates a new custom contact field with a name, type and optional length.
Create draft campaignCreates 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 contactsCreates a new mailing list with a name and signup form, and adds the email addresses you give to it.
Delete mailing listDeletes a mailing list by its list key, and optionally the contacts in it too.
Get campaign detailsGets a campaign by its campaign key, including its name, subject, sender, status and the lists it goes to.
Get mailing list detailsGets a mailing list's details by its list key, including its contact counts and the campaigns sent or scheduled to it.
Get segment detailsGets a segment of a mailing list by its list key and segment ID, including its name and conditions.
List contact fieldsLists all the contact fields in your account, standard and custom, with each field's name and type.
List contactsLists 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 listsLists the mailing lists in your Zoho Campaigns account, a range at a time and sorted if you like.
List segment contactsLists the contacts that belong to a segment, by its segment ID.
List topicsLists the topics in your account that contacts can subscribe to, with each topic's ID and name.
Subscribe or update contactAdds a contact to a mailing list by its list key, or updates the contact's details if already there, optionally under a topic.
Unsubscribe contactUnsubscribes a contact, identified by email, from a mailing list by its list key.
Update mailing listRenames 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

ContactinfocontactinfoobjectRequired
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 listlistkeytextRequired
Listkey for this request.
EmailidsemailidslistRequired
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 listlistkeytextRequired
Listkey for this request.
Statusstatustext
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

FieldnamefieldnametextRequired
Fieldname for this request.
FieldtypefieldtypetextRequired
Fieldtype for this request.One of: Text, Integer, Phone, Date, Picklist, Email, Checkbox, LongInteger, URL, textarea, and 5 more.
Fieldlengthfieldlengthnumber
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

CampaignnamecampaignnametextRequired
Campaignname for this request.
From emailfrom_emailtextRequired
From email for this request.
From namefrom_nametext
From name for this request.
SubjectsubjecttextRequired
Subject for this request.
Content urlcontent_urltext
Content url for this request.
List detailslist_detailsobjectRequired
List details for this request.
Topic idtopic_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

ListnamelistnametextRequired
Listname for this request.
SignupformsignupformtextRequired
Signupform for this request.One of: public, private.
EmailidsemailidslistRequired
Emailids for this request.
Listdescriptionlistdescriptiontext
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 listlistkeytextRequired
Listkey for this request.
DeletecontactsdeletecontactstextRequired
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

CampaignkeycampaignkeytextRequired
Campaignkey for this request.
Campaigntypecampaigntypetext
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 listlistkeytextRequired
Listkey for this request.
Filtertypefiltertypetext
Filtertype for this request.One of: sentcampaigns, scheduledcampaigns, recentcampaigns.
Fromindexfromindexnumber
Fromindex for this request.At least 1.
Rangerangenumber
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 listlistkeytextRequired
Listkey for this request.
CvidcvidnumberRequired
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 listlistkeytextRequired
Listkey for this request.
Statusstatustext
Status for this request.One of: active, recent, mostrecent, unsub, bounce.
Fromindexfromindexnumber
Fromindex for this request.At least 1.
Rangerangenumber
Range for this request.From 1 to 200.
Sortsorttext
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

Fromindexfromindexnumber
Fromindex for this request.At least 1.
Rangerangenumber
Range for this request.From 1 to 200.
Sortsorttext
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

CvidcvidnumberRequired
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

Detailsdetailsobject
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 listlistkeytextRequired
Listkey for this request.
ContactinfocontactinfoobjectRequired
Contactinfo for this request.
Sourcesourcetext
Source for this request.
Topic idtopic_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 listlistkeytextRequired
Listkey for this request.
ContactinfocontactinfoobjectRequired
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 listlistkeytextRequired
Listkey for this request.
NewlistnamenewlistnametextRequired
Newlistname for this request.
SignupformsignupformtextRequired
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
}

On this page