SurveyMonkey ACTION
Add Message Recipients
Add recipients to an invite message, from new contacts, existing contact IDs, contact lists, or any combination. Uses the bulk endpoint, so nothing is re-added: a recipient already on the message or collector comes back under
existing, while duplicate reports addresses repeated within this one request. See the documentation- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's SurveyMonkey account once, then configure and run Add Message Recipients 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: "survey_monkey-add-message-recipients",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
survey_monkey: { authProvisionId: "apn_xxxxxxx" },
survey: "Survey",
collectorId: "Collector",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "survey_monkey-add-message-recipients",
"configured_props": {
"survey_monkey": { "authProvisionId": "apn_xxxxxxx" },
"survey": "Survey",
"collectorId": "Collector"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "survey_monkey",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "survey_monkey-add-message-recipients",
arguments: {
survey: "Survey",
collectorId: "Collector",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
survey Survey | string | Select a Survey from the list.
Alternatively, you can provide a custom Survey ID. Required Dynamic |
collectorId Collector | string | Select one of the above survey's Collectors to get details of.
Alternatively, you can provide a custom Collector ID. Required Dynamic |
messageId Message ID | string | The ID of the invite message to add recipients to. Run List Invite Messages to find valid message IDs, or use the id returned by Create Invite Message. Required |
contacts Contacts | string[] | New contacts to add, each a JSON object. Email is required for email collectors and phone number for SMS collectors. Example: {"email": "jane@example.com", "first_name": "Jane", "last_name": "Doe"} or {"phone_number": "+1 202 555 0156"}. Careful with custom_fields: if any one contact supplies them, SurveyMonkey clears the existing custom fields of every other contact in the same call that does not. Optional |
contactIds Contact IDs | string[] | IDs of existing SurveyMonkey contacts to add as recipients, e.g. ["123456"]. Contacts live in your SurveyMonkey address book rather than in this action — find their IDs at GET /v3/contacts, which returns an id per contact, or in the succeeded[].id values a previous run of this action returned. Optional |
contactListIds Contact List IDs | string[] | IDs of existing contact lists whose contacts should be added as recipients, e.g. ["123456"]. Contact lists are managed in SurveyMonkey rather than here — find their IDs at GET /v3/contact_lists, or in the list's URL in the SurveyMonkey UI. 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
- survey_monkey-add-message-recipients
- Version
- 0.0.2
- App
- SurveyMonkey
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗