View as Markdown
SurveyMethods icon

SurveyMethods ACTION

Add Contact To Email List

Creates a email list. See docs here in 8.2
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SurveyMethods account once, then configure and run Add Contact To Email List 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: "surveymethods-add-contact-to-email-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surveymethods: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    emailListCode: "Email List Code",
  },
})

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 To Email List inputs
Property Type Description
email Email string
The email to add on email list
Required
emailListCode Email List Code string
The email list code
Required Dynamic
customFieldsValues Custom Fields Values string
The email list custom fields values. E.g. 123,Joe,Williams,Laptop,HP Pavilion
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
surveymethods-add-contact-to-email-list
Version
0.0.2
App
SurveyMethods
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes