Skip to main content
Server path: /surveymonkey-collectors | Type: Application | PCID required: Yes

Tools


surveymonkey_collectors_add_bulk_recipients

Add bulk recipients Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
message_idstringYesMessage ID
contact_list_idsstring[]NoContact list IDs to add as recipients
contactsobject[]YesArray of contact objects

surveymonkey_collectors_create_collector

Create collector Parameters:
ParameterTypeRequiredDefaultDescription
survey_idstringYesSurvey ID
allow_multiple_responsesbooleanNoAllow multiple responses per recipient
anonymous_typestringNoAnonymity level
close_datestringNoCollector close date (ISO 8601)
closed_page_messagestringNoMessage shown when collector is closed
disqualification_messagestringNoDisqualification message
namestringNoCollector name
passwordstringNoPassword for accessing the survey
password_enabledbooleanNoWhether password protection is enabled
redirect_urlstringNoURL to redirect to after completion
sender_emailstringNoSender email for email collectors
thank_you_messagestringNoThank you message shown after completion
thank_you_pageobjectNoThank you page configuration
typestringYesCollector type

surveymonkey_collectors_create_collector_message

Create collector message Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
body_htmlstringNoEmail body in HTML
body_textstringNoEmail body in plain text
is_branding_enabledbooleanNoWhether branding is shown
recipient_statusstringNoFilter recipients by status
subjectstringNoEmail subject
typestringYesMessage type

surveymonkey_collectors_delete_collector

Delete collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID

surveymonkey_collectors_delete_collector_message

Delete collector message Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
message_idstringYesMessage ID

surveymonkey_collectors_get_collector

Get collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID

surveymonkey_collectors_get_collector_message

Get collector message Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
message_idstringYesMessage ID

surveymonkey_collectors_get_collector_stats

Get collector stats Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID

surveymonkey_collectors_list_collector_messages

List collector messages Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
per_pageintegerNoNumber of results per page
pageintegerNoPage number

surveymonkey_collectors_list_collector_recipients

List collector recipients Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
per_pageintegerNoNumber of results per page
pageintegerNoPage number

surveymonkey_collectors_list_collectors

List collectors Parameters:
ParameterTypeRequiredDefaultDescription
survey_idstringYesSurvey ID
per_pageintegerNoNumber of results per page
pageintegerNoPage number
sort_bystringNoField to sort by
sort_orderstringNoSort order
includestringNoComma-separated list of additional fields to include

surveymonkey_collectors_list_message_recipients

List message recipients Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
message_idstringYesMessage ID
per_pageintegerNoNumber of results per page
pageintegerNoPage number

surveymonkey_collectors_send_collector_message

Send collector message Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
message_idstringYesMessage ID
scheduled_datestringNoISO 8601 date to schedule the send (omit to send immediately)

surveymonkey_collectors_update_collector

Update collector Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
allow_multiple_responsesbooleanNoAllow Multiple Responses
anonymous_typestringNoAnonymous Type
close_datestringNoClose Date
closed_page_messagestringNoClosed Page Message
namestringNoCollector name
passwordstringNoThe password value
password_enabledbooleanNoPassword Enabled
redirect_urlstringNoRedirect Url
statusstringNoCollector status
thank_you_messagestringNoThank You Message

surveymonkey_collectors_update_collector_message

Update collector message Parameters:
ParameterTypeRequiredDefaultDescription
collector_idstringYesCollector ID
message_idstringYesMessage ID
body_htmlstringNoBody Html
body_textstringNoBody Text
subjectstringNoThe subject value