Add Contact to Mailing List with Zoho Campaigns API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Zoho Campaigns, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Add Contact to Mailing List with the Zoho Campaigns API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Zoho Campaigns action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Add Contact to Mailing List action
1. Connect your Zoho Campaigns account
2. Select a Mailing List
3. Configure Contact Email
4. Optional- Configure Contact First Name
5. Optional- Configure Contact Last Name
6. Optional- Configure Source
7. Optional- Select a Topic
8. Optional- Configure Contact Additional Fields
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Add Contact to Mailing List on Zoho Campaigns

Description:You can use this API to add contacts to your mailing lists. [See the documentation](https://www.zoho.com/campaigns/help/developers/contact-subscribe.html)

Version:0.0.2

Key:zoho_campaigns-add-contact-to-mailing-list

View on GitHub

Zoho Campaigns Overview#

The Zoho Campaigns API opens up a world of possibilities for email marketing automation within Pipedream, allowing you to manage contacts, campaigns, and reports programmatically. You can connect Zoho Campaigns with other apps to create workflows that automate various tasks, such as synchronizing subscriber lists, triggering campaigns based on specific actions or events, and analyzing campaign performance with custom metrics.

Action Code#

import app from "../../zoho_campaigns.app.mjs";

export default {
  type: "action",
  key: "zoho_campaigns-add-contact-to-mailing-list",
  name: "Add Contact to Mailing List",
  version: "0.0.2",
  description: "You can use this API to add contacts to your mailing lists. [See the documentation](https://www.zoho.com/campaigns/help/developers/contact-subscribe.html)",
  props: {
    app,
    listkey: {
      propDefinition: [
        app,
        "mailingList",
      ],
      label: "Mailing List",
      description: "List Key to send a subscription mail to contacts of the list.",
    },
    contactEmail: {
      type: "string",
      label: "Contact Email",
      description: "Contact email can be added.",
    },
    contactFirstName: {
      type: "string",
      label: "Contact First Name",
      description: "Contact first name can be added.",
      optional: true,
    },
    contactLastName: {
      type: "string",
      label: "Contact Last Name",
      description: "Contact last name can be added.",
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "Contact source can be added.",
      optional: true,
    },
    topic_id: {
      propDefinition: [
        app,
        "topic",
      ],
      optional: true,
    },
    contactAdditionalFields: {
      type: "object",
      label: "Contact Additional Fields",
      description: "Any desired additional fields.",
      optional: true,
    },
  },
  methods: {
    getContactInfo(contactEmail, contactFirstName, contactLastName) {
      const contactInfo = {
        "Contact Email": contactEmail,
        ...this.contactAdditionalFields,
      };

      if (contactFirstName) {
        contactInfo["First Name"] = contactFirstName;
      }

      if (contactLastName) {
        contactInfo["Last Name"] = contactLastName;
      }

      return JSON.stringify(contactInfo);
    },
  },
  async run({ $ }) {
    const {
      app,
      contactEmail,
      contactFirstName,
      contactLastName,
      ...data
    } = this;

    const res = await app.addSubscriberToList({
      ...data,
      contactinfo: this.getContactInfo(contactEmail, contactFirstName, contactLastName),
    });
    if (res.status !== "success") {
      throw new Error(`${res.message} - ${JSON.stringify(res)}`);
    }
    $.export("summary", `Contact "${contactEmail}" added to mailing list successfully`);
    return res;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Zoho Campaigns	`app`	`app`	This component uses the Zoho Campaigns app.
Mailing List	`listkey`	`string`	Select a value from the drop down menu.
Contact Email	`contactEmail`	`string`	Contact email can be added.
Contact First Name	`contactFirstName`	`string`	Contact first name can be added.
Contact Last Name	`contactLastName`	`string`	Contact last name can be added.
Source	`source`	`string`	Contact source can be added.
Topic	`topic_id`	`string`	Select a value from the drop down menu.
Contact Additional Fields	`contactAdditionalFields`	`object`	Any desired additional fields.

Action Authentication#

Zoho Campaigns uses OAuth authentication. When you connect your Zoho Campaigns account, Pipedream will open a popup window where you can sign into Zoho Campaigns and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Campaigns API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoCampaigns.campaign.READZohoCampaigns.campaign.CREATEZohoCampaigns.campaign.UPDATEZohoCampaigns.contact.CREATEZohoCampaigns.contact.UPDATEZohoCampaigns.contact.READZohoCampaigns.userinfo.READ

Try it

Add Contact to Mailing List with Zoho Campaigns API on Weekly schedule from Schedule API

Schedule + Zoho Campaigns

Try it

Add Contact to Mailing List with Zoho Campaigns API on Monthly Schedule from Schedule API

Schedule + Zoho Campaigns

Try it

Create Campaign with Zoho Campaigns API on Daily schedule from Schedule API

Schedule + Zoho Campaigns

Try it

Create Campaign with Zoho Campaigns API on Weekly schedule from Schedule API

Schedule + Zoho Campaigns

Try it

Popular Triggers#

Custom Interval from the Schedule API

Trigger your workflow every N hours, minutes or seconds.

Try it

Daily schedule from the Schedule API

Trigger your workflow every day.

Try it

Monthly Schedule from the Schedule API

Trigger your workflow on one or more days each month at a specific time (with timezone support).

Try it

Weekly schedule from the Schedule API

Trigger your workflow on one or more days each week at a specific time (with timezone support).

Try it

New Campaign from the Zoho Campaigns API

Emit new event when a new campaign is created.

Try it

Popular Actions#

Add Contact to Mailing List with the Zoho Campaigns API

You can use this API to add contacts to your mailing lists. See the documentation

Try it

Create Campaign with the Zoho Campaigns API

You can create a campaign using this API. Using this API, you can set the campaign name, subject line, sender address; choose the intended mailing list.. See the documentation

Try it