Skip to main content
Zoho Campaigns logo
  • Category: marketing automation
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 39
  • Triggers: 0
  • Slug: ZOHO_CAMPAIGNS
  • Version: 20261101_00

Tools

Slug: ZOHO_CAMPAIGNS_ADD_CONTACTS_TO_MAILING_LISTAdd between one and ten email addresses to an existing Zoho Campaigns mailing list in one request.

Input Parameters

array
required
One to ten email addresses to add. They are sent to Zoho Campaigns as one comma-separated query value.
string
required
Existing mailing-list key to receive the contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_ADD_MAILING_LIST_AND_CONTACTSCreate a Zoho Campaigns mailing list and optionally add up to ten email addresses in the same call.

Input Parameters

string
required
Name for the new mailing list.
array
Up to ten contacts to add. Omit or pass an empty list to create an empty mailing list.
string
Optional mailing-list description.
string ("public" | "private")
Whether the list’s hosted signup form is public or private.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_ASSOCIATE_TAG_WITH_CONTACTAssociate an existing Zoho Campaigns contact tag with one contact email address. Zoho performs this state-changing operation through an HTTP GET request, so do not treat it as a safe read.

Input Parameters

string
required
Exact name of the existing contact tag to associate.
string
required
Email address of the contact that should receive the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_CLONE_CAMPAIGNClone an existing campaign into a new draft with a new name and subject. This action creates a draft and does not send it.

Input Parameters

string
required
Name for the cloned campaign draft.
string
required
Subject line for the cloned campaign draft.
string
Provider encoding type for the cloned draft, such as UTF-8.
string
Reply-to address override for the cloned draft.
string
Sender display name override for the cloned draft.
string
Verified sender email override for the cloned draft.
string
required
Campaign key to clone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_COUNT_MAILING_LIST_CONTACTSCount contacts in a mailing list for one subscription, bounce, or spam status.

Input Parameters

string ("active" | "unsub" | "bounce" | "spam")
Contact status to count.
string
required
Mailing-list key whose contacts should be counted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_CREATE_CAMPAIGNCreate an email campaign draft for mailing-list or segment recipients. This action creates a draft only and does not send or schedule the campaign.

Input Parameters

string
required
Name for the campaign draft.
string
required
Campaign email subject line.
string
Topic ID for the campaign. Required only when the connected organization uses Zoho’s updated topic management.
string
Public HTTP or HTTPS URL from which Zoho can fetch the campaign HTML.
array
Standalone recipient segment IDs. Use these only when mailing_lists is empty; Zoho ignores them when mailing lists are supplied.
string
Display name for the sender.
string
required
Verified sender email configured in Zoho Campaigns.
array
Recipient mailing lists. Each entry selects a whole list or specific segments within that list. When supplied, these recipients take precedence over standalone segment_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_CREATE_CONTACT_FIELDCreate a custom contact field in Zoho Campaigns. The documented API does not provide an update or delete operation for custom fields.

Input Parameters

string
required
Display name for the custom contact field. Use only letters, numbers, spaces, underscores, and hyphens.
string ("Text" | "Integer" | "Phone" | "Date" | "Picklist" | "Email" | "Checkbox" | "LongInteger" | "URL" | "textarea" | "RadioOption" | "Multiselect" | "DateTime" | "Decimal" | "Percent")
required
Zoho Campaigns field type for the custom contact field.
integer
Maximum field length for field types that support a length.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_CREATE_MERGE_TAGCall Zoho Campaigns’ deprecated merge-tag endpoint for compatibility. Live provider evidence confirms that it creates nothing and only reports that merge tags are generated automatically for contact fields. Use List Contact Fields to discover those fields instead.

Input Parameters

string
required
Legacy contact field name associated with the merge tag. The endpoint currently creates nothing because Zoho generates merge tags automatically.
string
required
Legacy contact field type. Zoho’s documentation is malformed, but its request example sends this value as fieldtype.
string
required
Legacy merge-tag name. Zoho’s malformed parameter table omits this field, but its request example includes mergename. The deprecated endpoint currently ignores creation requests.
string
Legacy default value for email campaigns. Sent as mailval, matching the provider example rather than the malformed table’s mailvalue spelling.
string
Legacy default value for social campaigns. Sent as socialval, matching the provider example rather than the malformed table’s socialvalue spelling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_CREATE_TAGCreate a Zoho Campaigns contact tag with an optional description and a color. Returns the tag ID and a confirmation message on success. The tag may be created even if the tool subsequently reports a failure.

Input Parameters

string
required
Name for the contact tag.
string
Tag color as a six-digit hexadecimal value, including the leading #.
string
Optional description for the contact tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_CREATE_TOPICCreate a brand topic or brand-product topic. Zoho Campaigns documents no API endpoint for deleting a topic, so this action may leave durable account state.

Input Parameters

string
required
Topic name.
string
Product ID for a brand-product topic. Omit this for a brand topic. Zoho’s documentation is contradictory about when this field is required, and support depends on the connected organization’s topic model.
string
required
Topic description shown to subscribers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_DELETE_CAMPAIGNPermanently delete one Zoho Campaigns campaign by exact campaign key. This destructive operation cannot be undone. Verify the campaign and obtain explicit confirmation before calling it.

Input Parameters

string
required
Exact campaign key to permanently delete. Verify the campaign first; deletion cannot be undone.
boolean
required
Must be true to confirm permanent deletion of the specified campaign. This value is not sent to Zoho Campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_DELETE_MAILING_LISTPermanently delete a mailing list. Contacts remain in the organization by default; setting delete_contacts to true also permanently deletes them and is more destructive, so that mode requires confirm_delete_contacts=true.

Input Parameters

string
required
Mailing-list key to permanently delete.
boolean
Also permanently delete the mailing list’s contacts from the organization. Leave false unless this broader destructive deletion is explicitly intended.
boolean
Must be true when delete_contacts is true to confirm permanent deletion of the list’s contacts from the entire organization. Not required when delete_contacts is false. This confirmation is not sent to Zoho Campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_DELETE_TAGPermanently delete one Zoho Campaigns contact tag by exact name. Zoho performs this destructive operation through an HTTP GET request, so do not treat it as a safe read. Verify the tag and obtain explicit confirmation before calling it.

Input Parameters

string
required
Exact contact tag name to permanently delete.
boolean
required
Must be true to confirm permanent deletion of the specified contact tag. This confirmation is not sent to Zoho Campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_DISSOCIATE_TAG_FROM_CONTACTRemove an existing Zoho Campaigns contact-tag association without deleting the tag or contact.

Input Parameters

string
required
Existing tag name to remove from the contact.
string
required
Contact email whose tag association should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_GET_CAMPAIGN_DETAILSGet a campaign’s status, sender, recipients, reach, and summary report data.

Input Parameters

string
required
Campaign key to inspect.
string ("normal" | "abtesting")
Campaign type used to resolve the details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_GET_CAMPAIGN_REPORTGet aggregate delivery, open, click, bounce, and reach metrics for one campaign.

Input Parameters

string
required
Campaign key whose aggregate report should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_GET_COUPON_DETAILSGet a coupon’s code, recipient, campaign, sent and expiry dates, and current status.

Input Parameters

string
required
Coupon code to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_GET_LAST_CAMPAIGN_REPORTGet aggregate delivery, open, click, bounce, and reach metrics for the organization’s most recently sent campaign. Fails clearly when the account has no sent campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_GET_MAILING_LIST_DETAILSGet a mailing list’s contact statistics, client and device breakdowns, and optionally filtered campaign details one page at a time.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page.
string
required
Mailing-list key returned by List Mailing Lists or Create Mailing List.
integer
Maximum campaign-detail records to return on this page.
string ("sentcampaigns" | "scheduledcampaigns" | "recentcampaigns")
Campaign subset to include in the mailing-list details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_GET_SEGMENT_DETAILSGet the filtering criteria and metadata for a segment in a mailing list.

Input Parameters

string
required
Mailing-list key that owns the segment.
string
required
Segment ID returned in mailing-list metadata; strings are accepted to preserve large IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_CAMPAIGN_RECIPIENTSList recipients in one campaign delivery or engagement state, one page at a time. Pagination is provisional because no sent campaign was available to verify successful page output.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page.
integer
Maximum recipients to request on this page.
string
required
Sent campaign key whose recipients should be listed.
string ("sentcontacts" | "openedcontacts" | "optoutcontacts" | "spamcontacts" | "unopenedcontacts" | "clickedcontacts" | "senthardbounce" | "sentsoftbounce" | "unsentcontacts")
required
Delivery or engagement state to select.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_CONTACT_FIELDSList standard and custom contact fields available to the connected Campaigns organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_MAILING_LIST_CONTACTSList contacts in a mailing list, optionally filtered by subscription or bounce status, one page at a time.

Input Parameters

string ("asc" | "desc")
Sort direction for returned contacts.
string
Opaque continuation cursor from a previous response; omit for the first page.
string ("active" | "recent" | "mostrecent" | "unsub" | "bounce")
Contact status to include.
string
required
Mailing-list key whose contacts should be returned.
integer
Maximum contacts to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_MAILING_LISTSList mailing lists and their contact, ownership, segment, and status metadata one page at a time.

Input Parameters

string ("asc" | "desc")
Sort direction for mailing lists.
string
Opaque continuation cursor from a previous response; omit for the first page and pass it back unchanged to continue.
integer
Maximum mailing lists to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_OPEN_WORKFLOWSList open custom workflows one page at a time.

Input Parameters

string ("my" | "all" | "other")
Return workflows created by the connected user, all users, or other users.
string
Opaque continuation cursor from a previous response; omit for the first page and pass it back unchanged to continue.
integer
Maximum workflows to request on this page.
string ("asc" | "desc")
Sort workflows in ascending or descending order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_RECENT_CAMPAIGNSList recent campaigns filtered by lifecycle status, one page at a time.

Input Parameters

string ("asc" | "desc")
Sort direction for campaigns.
string
Opaque continuation cursor from a previous response; omit for the first page and pass it back unchanged to continue.
string ("all" | "all campaigns" | "drafts" | "scheduled" | "inprogress" | "sent" | "stopped" | "canceled" | "tobereviewed" | "reviewed" | "paused" | "intesting")
Campaign lifecycle status to include.
integer
Maximum campaigns to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_RECENTLY_SENT_CAMPAIGNSReturn up to a requested number of the most recently sent campaigns; an account with no sent campaigns returns an empty list.

Input Parameters

integer
Maximum recent sent campaigns to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_SEGMENT_CONTACTSList contacts belonging to a Zoho Campaigns segment one page at a time. Pagination is provisional because no live segment fixture was available during probing.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page.
integer
Maximum contacts to request on this page.
string
required
Segment ID whose contacts should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_TAGSList all Zoho Campaigns contact tags and their metadata. Zoho requires contact UPDATE permission even though this action only reads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_TOPIC_PRODUCTSList products available for brand-product topics one page at a time. Organizations using the brand topic model receive an explicit incompatibility error because that model has no topic products.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page and pass it back unchanged to continue.
integer
Maximum products to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_LIST_TOPICSList subscription topics for the organization one page at a time.

Input Parameters

string
Opaque continuation cursor from a previous response; omit for the first page and pass it back unchanged to continue.
integer
Maximum topics to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_MARK_COUPON_USEDIrreversibly mark a Zoho Campaigns coupon as used. The documented API provides no action to restore the coupon’s prior status, so use this only after the user explicitly confirms the state change.

Input Parameters

string
required
Coupon code to irreversibly mark as used.
boolean
required
Must be true to confirm permanently marking this coupon as used. The documented API provides no way to restore its prior status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_MOVE_CONTACT_TO_DO_NOT_MAILPermanently suppress one email address across the connected Zoho Campaigns organization by moving it to the Do-Not-Mail registry. This is broader than unsubscribing from one mailing list, cannot be reversed through the documented API, and was not live-tested because even a test call creates durable suppression. Requires confirm_permanent_suppression=true after the user explicitly confirms this consequence.

Input Parameters

string
required
Email address to suppress across the entire organization. This is broader than unsubscribing from one mailing list and cannot be reversed through the documented API. Confirm this permanent suppression before calling.
boolean
required
Must be true to confirm irreversible organization-wide suppression of this email address. This confirmation is not sent to Zoho Campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_SCHEDULE_CAMPAIGNSchedule a reviewed campaign for future delivery. This commits the campaign to sending, and this toolkit has no cancellation action; call only after the user confirms the campaign, date, time, and time zone.

Input Parameters

string ("AM" | "PM")
required
AM or PM for the delivery time.
string
required
Reviewed campaign key to schedule.
string
required
Delivery date in MM/DD/YYYY format.
integer
required
Delivery hour on a 12-hour clock (1-12).
integer ("0" | "5" | "10" | "15" | "20" | "25" | "30" | "35" | "40" | "45" | "50" | "55")
required
Delivery minute in five-minute increments (0-55).
string
Recipient time zone to send as sendingTZ, for example Asia/Kolkata. Zoho documents this separately from the sender-time-zone option.
boolean
Whether to set Zoho’s istimewarp option for sender-time-zone delivery. This does not select recipient-local-time delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_SEND_CAMPAIGNImmediately and irreversibly send a reviewed Zoho Campaigns campaign to its entire configured audience. This is not a preview, test, draft, or scheduling operation. Delivery cannot be canceled or undone after the call, so use only after the user explicitly confirms the campaign and audience are final.

Input Parameters

string
required
Reviewed campaign key to send immediately to every configured recipient. Sending cannot be undone.
boolean
required
Must be true to confirm immediate delivery of the reviewed campaign to its full configured audience. This is not a preview or test, and the send cannot be canceled or undone after this call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_SUBSCRIBE_CONTACTAdd or update one contact in a mailing list. Depending on the mailing-list settings, Zoho Campaigns may send the contact a confirmation email.

Input Parameters

string
Optional source label for the contact.
object
required
Contact details to add or update in the mailing list.
string
required
Mailing-list key to subscribe the contact to.
string
Topic ID to associate when topic management requires it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_TRIGGER_WORKFLOW_CONTACTSAdd between one and 200 contacts to a Zoho Campaigns custom workflow. Triggering contacts can run the workflow’s downstream automations, so this action requires confirm_trigger=true after the user confirms that effect.

Input Parameters

string
required
Mailing-list key associated with the contacts and workflow trigger.
string
required
Trigger key returned for the selected custom workflow.
string
required
Custom workflow key whose trigger should receive the contacts.
array
required
Between one and 200 contact email addresses to add to the custom workflow. Triggering can run the workflow’s downstream automations.
boolean
required
Must be true to confirm adding these contacts to the workflow and potentially running its downstream automations. This confirmation is not sent to Zoho Campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_UNSUBSCRIBE_CONTACTUnsubscribe one contact from a mailing list or topic. This is a reversible, list-level opt-out and does not add the address to the organization-wide Do-Not-Mail registry.

Input Parameters

object
required
Contact to unsubscribe. This affects only the specified mailing list and does not place the address in the organization-wide Do-Not-Mail registry.
string
required
Mailing-list key to unsubscribe the contact from.
string
Topic ID when the unsubscribe applies to a topic association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CAMPAIGNS_UPDATE_MAILING_LISTRename a mailing list and set its signup form visibility.

Input Parameters

string
required
New mailing-list name.
string
required
Mailing-list key to update.
string ("public" | "private")
required
Whether the hosted signup form is public or private.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not