View as Markdown
SARE icon

SARE ACTION

Add Email

Add an email to SARE. Optionally, assign the subscriber to a group. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SARE account once, then configure and run Add Email 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: "sare-add-email",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sare: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    gsm: "GSM",
  },
})

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 Email inputs
Property Type Description
email Email string
The email address of the subscriber.
Required
gsm GSM string
The GSM number of the subscriber.
Optional
groups Groups string[]
The group to assign the email to.
Optional Dynamic
name Name string
The name assigned to the email address.
Optional
comment Comment string
Address comment.
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
sare-add-email
Version
0.0.2
App
SARE
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes