View as Markdown
ReferralHero icon

ReferralHero ACTION

Add Subscriber

Adds a new subscriber to to a list. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ReferralHero account once, then configure and run Add Subscriber 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: "referralhero-add-subscriber",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    referralhero: { authProvisionId: "apn_xxxxxxx" },
    listId: "List",
    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 Subscriber inputs
Property Type Description
listId List string
Identifier of a list
Required Dynamic
email Email string
Email address of the subscriber
Required
domain Domain string
The URL for the referral link
Required
name Name string
Name of the subscriber
Optional
doubleOptin Double Opt-in boolean
If set to false, the subscriber will not receive a confirmation email
Optional
source Source string
The source of the subscriber. Used for analytics.
Optional
referrer Referrer boolean
Set a referrer for the subscriber by providing the referrer's referral code or email
Optional
conversionValue Conversion Value string
The monetary value of the referral
Optional
pending Pending boolean
Set to true to set the referral status to pending
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
referralhero-add-subscriber
Version
0.0.2
App
ReferralHero
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes