# Add Message Recipients — SurveyMonkey

> 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…

- Key: `survey_monkey-add-message-recipients`
- Type: Action (Write)
- Version: 0.0.2
- App: SurveyMonkey (`survey_monkey`) — https://pipedream.com/apps/survey-monkey.md
- This page (HTML): https://pipedream.com/apps/survey-monkey/actions/add-message-recipients
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/survey_monkey/actions/add-message-recipients/add-message-recipients.mjs

## Description

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](https://api.surveymonkey.com/v3/docs?javascript#api-endpoints-post-collectors-collector_id-messages-message_id-recipients-bulk)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `survey` | `string` | Yes | Select a Survey from the list. Alternatively, you can provide a custom Survey ID. Options are loaded from the connected account. |
| `collectorId` | `string` | Yes | Select one of the above survey's Collectors to get details of. Alternatively, you can provide a custom Collector ID. Options are loaded from the connected account. |
| `messageId` | `string` | Yes | 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. |
| `contacts` | `string[]` | No | 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. |
| `contactIds` | `string[]` | No | 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. |
| `contactListIds` | `string[]` | No | 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. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/survey-monkey.md · All apps: https://pipedream.com/apps