View as Markdown
Stannp icon

Stannp ACTION

Create a New Recipient

Creates a new recipient in a specified group. See the Stannp documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stannp account once, then configure and run Create a New Recipient 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: "stannp-create-recipient",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stannp: { authProvisionId: "apn_xxxxxxx" },
    groupId: "Group ID",
    firstName: "First Name",
  },
})

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.

Create a New Recipient inputs
Property Type Description
groupId Group ID string
Select the group ID
Optional Dynamic
firstName First Name string
The first name of the recipient.
Optional
lastName Last Name string
The last name of the recipient.
Optional
address1 Address Line 1 string
The first line of the address.
Optional
address2 Address Line 2 string
The second line of the address.
Optional
address3 Address Line 3 string
The third line of the address.
Optional
city City string
The city of the address.
Optional
postcode Postal Code string
The postal code of the address.
Optional
country Country string
The ISO 3166-1 Alpha 2 Country Code (e.g., GB, US, FR).
Optional
email Email Address string
The email address of the recipient.
Optional
phoneNumber Phone Number string
The phone number of the recipient.
Optional
refId Reference ID string
An alternative ID to associate the recipient with an ID in another service.
Optional
onDuplicate On Duplicate string
What to do if a duplicate recipient is found (update/ignore/duplicate).
Optional
customFields Custom Fields object
Additional fields to the recipient.
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
stannp-create-recipient
Version
0.0.2
App
Stannp
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes