View as Markdown
SurveyMonkey icon

SurveyMonkey ACTION

List Invite Messages

Retrieve a collector's invite messages, each with its id and status. Run this to find a Message ID for Add Message Recipients, Send Invite Message, or the Copy From Message option on Create Invite Message. Filter by Status not_sent to get only the messages that can still be sent. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SurveyMonkey account once, then configure and run List Invite Messages 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-list-invite-messages",
  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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Invite Messages inputs
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
status Status string
Return only the messages with this status. not_sent is the set Send Invite Message accepts — it rejects a message that is already sent or still processing. Omit to return every message on the collector.
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-list-invite-messages
Version
0.0.2
App
SurveyMonkey
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes