← UpViral

Add Contact with UpViral API

Pipedream makes it easy to connect APIs for UpViral and 2,700+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Contact with the UpViral API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Add Contact with the UpViral API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add Contact action
    1. Connect your UpViral account
    2. Select a Campaign Id
    3. Configure Email
    4. Optional- Configure Name
    5. Optional- Configure IP Address
    6. Optional- Configure Referral Code
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Add Contact with UpViral API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + UpViral
 
Try it
Add Contact with UpViral API on New Submission from Typeform API
Typeform + UpViral
 
Try it
Add Contact with UpViral API on Custom Events from Zoom API
Zoom + UpViral
 
Try it
Add Contact with UpViral API on New Submission (Instant) from Jotform API
Jotform + UpViral
 
Try it
Add Contact with UpViral API on New Scheduled Tasks from Pipedream API
Pipedream + UpViral
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Add Contact on UpViral
Description:Add a new contact in your particular campaign. [See the documentation](https://api.upviral.com/#add-contact)
Version:0.0.1
Key:upviral-add-contact

Code

import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import upviral from "../../upviral.app.mjs";

export default {
  key: "upviral-add-contact",
  name: "Add Contact",
  version: "0.0.1",
  description: "Add a new contact in your particular campaign. [See the documentation](https://api.upviral.com/#add-contact)",
  type: "action",
  props: {
    upviral,
    campaignId: {
      propDefinition: [
        upviral,
        "campaignId",
      ],
      reloadProps: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The user's email address.",
    },
    name: {
      type: "string",
      label: "Name",
      description: "The user's name.",
      optional: true,
    },
    ipAddress: {
      type: "string",
      label: "IP Address",
      description: "The user's IP Address.",
      optional: true,
    },
    referralCode: {
      type: "string",
      label: "Referral Code",
      description: "The unique referral code (Last part of unique Referral URL). For example - https://upvir.al/ref/XXXX, Referral Code will be XXXX.This will be the referral code of the person who referred this new contact. The original participant will get the credit for this new contact.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.campaignId) {
      let count = 0;
      let data = new FormData();
      data.append("campaign_id", this.campaignId);

      const { custom_fields: customFields } = await this.upviral.listCustomFields({
        data,
        headers: data.getHeaders(),
      });

      for (const field of customFields) {
        props[`customField-${field}`] = {
          type: "string",
          label: field,
          description: `Custom field ${++count}`,
          optional: true,
        };
      }
    }
    return props;
  },
  methods: {
    parseCustomFields() {
      const customFields = Object.entries(this).filter(([
        key,
      ]) => key.includes("customField-"))
        .map(([
          key,
          value,
        ]) => ([
          key.split("-")[1],
          value,
        ]));

      return JSON.stringify(Object.fromEntries(customFields)) || null;
    },
  },
  async run({ $ }) {
    var bodyFormData = new FormData();
    bodyFormData.append("campaign_id", this.campaignId);
    bodyFormData.append("email", this.email);
    if (this.name) bodyFormData.append("name", this.name);
    if (this.ipAddress) bodyFormData.append("ip_address", this.ipAddress);
    if (this.referralCode) bodyFormData.append("referral_code", this.referralCode);
    bodyFormData.append("custom_fields", this.parseCustomFields() );

    const response = await this.upviral.addContact({
      $,
      data: bodyFormData,
      headers: bodyFormData.getHeaders(),
    });

    if (response.result === "error") {
      throw new ConfigurationError(response.message);
    }

    $.export("$summary", `A new contact with UID: '${response.uid}' was successfully created!`);
    return response;
  },
};

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.
LabelPropTypeDescription
UpViralupviralappThis component uses the UpViral app.
Campaign IdcampaignIdstringSelect a value from the drop down menu.
Emailemailstring

The user's email address.

Namenamestring

The user's name.

IP AddressipAddressstring

The user's IP Address.

Referral CodereferralCodestring

The unique referral code (Last part of unique Referral URL). For example - https://upvir.al/ref/XXXX, Referral Code will be XXXX.This will be the referral code of the person who referred this new contact. The original participant will get the credit for this new contact.

Authentication

UpViral uses API keys for authentication. When you connect your UpViral account, Pipedream securely stores the keys so you can easily authenticate to UpViral APIs in both code and no-code steps.

To get your UpViral API Key, go to your Profile, then click the "API Key" tab.

About UpViral

UpViral is the Ultimate Viral Referral Platform. It allows you to run viral campaigns - such as contests, giveaways and more.

More Ways to Use UpViral

Actions

Add Points with the UpViral API

Add points in user profile. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,700+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Pinterest
Pinterest
Pinterest is a visual discovery engine for finding ideas like recipes, home and style inspiration, and more.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.