SurveyMonkey ACTION
Create Invite Message
Create an invite message on an email or SMS collector. Add recipients with Add Message Recipients, then deliver it with Send Invite Message. See the documentation
- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's SurveyMonkey account once, then configure and run Create Invite Message 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-create-invite-message",
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-create-invite-message",
"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-create-invite-message",
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 |
type Type | string | The type of message to create. Use sms for SMS collectors and invite for email collectors. Optional |
subject Subject | string | Subject line of the email message. Not used for SMS messages. Optional |
bodyText Body Text | string | The plain text body of the message, and the only body an SMS message can use. SurveyMonkey advises keeping an SMS body to 30 characters or fewer, including spaces, so the invitation stays a single text. Include the [SurveyLink] placeholder, or recipients get an invitation with no way to reach the survey. Per SurveyMonkey's Anti-Spam Policy the [OptOutLink] must stay visible and its purpose clearly explained. Optional |
bodyHtml Body HTML | string | The HTML body of an email message, and email-only — it does not apply to sms messages, and it overrides Body Text when both are set. The same placeholders apply as for Body Text — [SurveyLink], [OptOutLink], [PrivacyLink] and [FooterLink] — and the Anti-Spam Policy requires that the opt-out link stay visible rather than being hidden in the markup. Optional |
fromMessageId Copy From Message | string | The ID of an existing message on this collector to copy the new message from, e.g. to reuse a template. Run List Invite Messages to find valid message IDs. Optional |
fromCollectorId Copy From Collector ID | string | Copy the message from the most recent message on another collector. Optional |
includeRecipients Include Recipients | boolean | Whether to copy the recipients of the message being copied from. Optional |
recipientStatus Recipient Status | string | The set of recipients to send to. Optional |
embedFirstQuestion Embed First Question | boolean | Whether to embed the survey's first question in an email invitation. Optional |
isBrandingEnabled Is Branding Enabled | boolean | Whether SurveyMonkey branding is shown in the message. 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-create-invite-message
- Version
- 0.0.2
- App
- SurveyMonkey
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗