View as Markdown
UpViral icon

UpViral ACTION

Add Contact

Add a new contact in your particular campaign. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's UpViral account once, then configure and run Add Contact from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "upviral-add-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    upviral: { authProvisionId: "apn_xxxxxxx" },
    campaignId: "Campaign Id",
    email: "Email",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Add Contact inputs
Property Type Description
campaignId Campaign Id string
The Id of the campaign.
Required Dynamic
email Email string
The user's email address.
Required
name Name string
The user's name.
Optional
ipAddress IP Address string
The user's IP Address.
Optional
referralCode Referral Code string
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

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
upviral-add-contact
Version
0.0.2
App
UpViral
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes