Create collector with the SurveyMonkey API

Creates a collector for a survey. A weblink collector returns the link to share in url, and it is the only type the free plan can create. An email collector only sets the invitation up: recipients and sending stay in SurveyMonkey.

Identifier
surveymonkey_create_collector

The request

POST https://connect.reportei.com/api/tools/surveymonkey_create_collector/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "survey_id": "<survey_id>",
    "type": "weblink",
    "name": "<name>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
survey_idstringYesId of the survey, from List surveys.
typestringYesweblink gives a link to share, returned in url. email needs a paid plan, and its invitations are sent from SurveyMonkey.Values: weblink, email
namestringYesName of the collector, shown only to the account.
thank_you_pageobjectNoCustom thank-you page shown after a response.
redirect_typestringNoEnd of the survey: url goes to redirect_url (or the standard thank-you page when it is empty), close closes the window and loop starts over, only for a weblink with allow_multiple_responses.Values: url, close, loop
redirect_urlstringNoURL the respondent goes to after finishing.
close_datestringNoWhen the collector stops accepting responses, as an ISO 8601 date and time.
closed_page_messagestringNoMessage shown when the collector is closed.
response_limitintegerNoCloses the collector after this many responses.
allow_multiple_responsesbooleanNoLets the same browser answer more than once. Not for email collectors.
anonymous_typestringNoTurns off IP tracking; in an email collector, fully_anonymous also drops the email and name of the respondent.Values: not_anonymous, partially_anonymous, fully_anonymous
edit_response_typestringNoWhen a respondent can still change the answers.Values: until_complete, never, always
display_survey_resultsbooleanNoShows the current results to the respondent at the end.
passwordstringNoPassword the respondent must type to open the survey.
disqualification_messagestringNoMessage for a respondent who is disqualified by the survey logic.
disqualification_urlstringNoURL a disqualified respondent goes to.

Supported connections

Your customer connects their SurveyMonkey account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/surveymonkey, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/surveymonkey_create_collector. It becomes your agent's tool definition with no conversion.

Other SurveyMonkey tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.