Collectors
create
collectors.create
Create a weblink or email collector for a survey, which is what gives it a public link
Risk: write
type is weblink or email; sms exists in the API but cannot be created here. A weblink collector answers a public url, and an email collector needs messages and recipients before it sends anything.
Output
delete
collectors.delete
Delete a collector. Its link stops working, and the responses it gathered stay
Risk: destructive · Irreversible
{ collector_id, deleted: true }. Its link stops working; the responses it gathered stay on the survey.
Output
get
collectors.get
Read one collector with its settings, link and status
Risk: read
list
collectors.list
List the collectors of a survey with their links and status
Risk: read
{ data } of collectors. include adds their messages, name filters by name, and start_date plus end_date filter by creation.
Output
links full type
links full type
data full type
data full type
update
collectors.update
Change a collector settings, or open and close it by status
Risk: write
status is the field that opens or closes it, and type cannot be changed.
Output
Contact Lists
copy
contactLists.copy
Copy a contact list, optionally under a new name
Risk: write
name defaults to a copy of the original name.
Output
create
contactLists.create
Create an empty contact list
Risk: write
delete
contactLists.delete
Delete a contact list. The contacts on it stay on the account
Risk: destructive · Irreversible
{ contact_list_id, deleted: true }. The contacts on it stay on the account.
Output
get
contactLists.get
Read one contact list
Risk: read
list
contactLists.list
List the contact lists on the account
Risk: read
{ data } of contact lists on the account, 50 a page by default.
Output
links full type
links full type
data full type
data full type
merge
contactLists.merge
Copy every contact from list_id into this list. list_id keeps its contacts
Risk: write
list_id into the list in the URL (contact_list_id) and answers that list, { id, name, href }. The plugin adds source_list_id and target_list_id. list_id keeps its contacts.
Output
update
contactLists.update
Rename a contact list
Risk: write
name, which renames the list.
Output
Contacts
bulkCreate
contacts.bulkCreate
Create up to a few hundred contacts in one call, optionally updating existing ones
Risk: write
contacts and answers { succeeded, invalids, existing }. update_existing: true beside contacts (or on an entry) updates the contact when its email is already known instead of adding it to existing.
contacts full type
contacts full type
succeeded full type
succeeded full type
existing full type
existing full type
create
contacts.create
Create a contact with a name and an email or a phone number
Risk: write
delete
contacts.delete
Delete a contact. It stops receiving invites and leaves every contact list
Risk: destructive · Irreversible
{ contact_id, deleted: true }. The contact leaves every list and stops receiving invites.
Output
get
contacts.get
Read one contact with its custom fields and status
Risk: read
custom_fields and status.
Output
list
contacts.list
List contacts on the account, filtered by status or a search field
Risk: read
{ data }. status takes active, optout or bounced. sort_by and search_by take a field name, or a custom field number as 1 through 6.
Output
links full type
links full type
data full type
data full type
listFields
contacts.listFields
List the custom contact fields and their labels
Risk: read
{ data } of the custom contact fields, with the label to show and the id to use as a key in custom_fields.
Output
links full type
links full type
data full type
data full type
update
contacts.update
Change a contact name, email, phone number or custom fields
Risk: write
custom_fields replaces the whole map.
Output
updateField
contacts.updateField
Rename a custom contact field
Risk: write
label, which renames the field. The id never changes, so a rename does not break a stored custom_fields key.
Output
Folders
create
folders.create
Create a folder to group surveys in
Risk: write
title and answers the folder. The reference’s example uses Title, which the API ignores (the folder comes back as “New Folder”).
Output
list
folders.list
List the survey folders on the account
Risk: read
{ data } of survey folders.
Output
links full type
links full type
data full type
data full type
Messages
create
messages.create
Draft an invite or reminder for an email collector. Nothing is sent until send is called
Risk: write
type is invite for the first send, reminder to chase non-responders, and thank_you for the follow-up note. Nothing is sent: a message needs recipients and then messages.send. The body goes in body_text (or body_html, which wins) and must include [SurveyLink], [OptOutLink], [PrivacyLink] and [FooterLink].
Output
get
messages.get
Read one message subject and body
Risk: read
list
messages.list
List the invite and reminder messages of a collector
Risk: read
{ data } of the collector’s messages.
Output
links full type
links full type
data full type
data full type
send
messages.send
Send a message to every recipient on it. This mails real people, so check the recipients first
Risk: destructive
scheduled_date defers the send instead of sending now. The answer is the scheduled message (is_scheduled, recipients, type), which has no id.
Output
update
messages.update
Change a message subject, body or type before it is sent
Risk: write
Pages
create
pages.create
Add a page to a survey, optionally at a given position
Risk: write
position is 1-based; omitting it appends the page.
Output
questions full type
questions full type
delete
pages.delete
Delete a page and the questions on it. There is no undo
Risk: destructive · Irreversible
{ survey_id, page_id, deleted: true }. The questions on the page go with it.
Output
get
pages.get
Read one page of a survey
Risk: read
question_count.
Output
questions full type
questions full type
list
pages.list
List the pages of a survey in their order
Risk: read
{ data } in page order. A survey always has at least one page once it has questions.
Output
links full type
links full type
data full type
data full type
update
pages.update
Change a page title, description or position
Risk: write
position reorders the page within the survey.
Output
questions full type
questions full type
Questions
create
questions.create
Add a question to a page. The family and subtype decide the question type, and the headings carry the text
Risk: write
family and subtype are required and decide the question type, for example single_choice with vertical. At least one heading is required and it is the question text. answers.choices carries the options for a choice question.
headings full type
headings full type
required full type
required full type
sorting full type
sorting full type
validation full type
validation full type
quiz_options full type
quiz_options full type
display_options full type
display_options full type
answers full type
answers full type
headings full type
headings full type
required full type
required full type
answers full type
answers full type
delete
questions.delete
Delete a question and the answers recorded for it. There is no undo
Risk: destructive · Irreversible
get
questions.get
Read one question with its choices and settings
Risk: read
headings full type
headings full type
required full type
required full type
answers full type
answers full type
list
questions.list
List the questions on one page of a survey
Risk: read
{ data } in question order. Each question carries its family, subtype, headings and, for a choice question, its choices.
Output
links full type
links full type
data full type
data full type
update
questions.update
Change a question heading, position, required rule, visibility or choices
Risk: write
visible: false hides the question without deleting it, and the answers already recorded stay.
headings full type
headings full type
required full type
required full type
answers full type
answers full type
headings full type
headings full type
required full type
required full type
answers full type
answers full type
Recipients
bulkCreate
recipients.bulkCreate
Add up to a few hundred recipients to a message in one call
Risk: write
contacts and answers { succeeded, invalids, existing }. A recipient already on the message comes back under existing, as its email address, rather than failing the call.
contacts full type
contacts full type
succeeded full type
succeeded full type
existing full type
existing full type
create
recipients.create
Add one recipient to a message by email address
Risk: write
list
recipients.list
List the recipients on one message with their delivery status
Risk: read
{ data } with each recipient’s mail_status and survey_response_status, which is how you tell who has answered.
Output
links full type
links full type
data full type
data full type
Responses
create
responses.create
Record a response through a collector, as data entry. Nothing is mailed to a respondent
Risk: write
/collectors/{id}/responses, because a collector owns the response link. response_status sets whether it counts as completed. recipient_id is required for an email collector. Nothing is mailed to a respondent.
pages full type
pages full type
pages full type
pages full type
delete
responses.delete
Delete one response and its answers. The counts on the survey change and there is no undo
Risk: destructive · Irreversible
{ survey_id, response_id, deleted: true }. The survey’s counts change.
Output
deleteAll
responses.deleteAll
Delete every response a collector gathered. There is no undo, and the collector stays open
Risk: destructive · Irreversible
{ collector_id, deleted: true }. There is no undo, and the collector stays open so it can gather more.
Output
get
responses.get
Read one response with its answers
Risk: read
choice_id, row_id, col_id or other_id, which you map to text with surveys.getDetails.
Output
pages full type
pages full type
getDetails
responses.getDetails
Read one response with its answers and the page and question detail
Risk: read
responses.get plus the question detail. responses.get is enough when you already cached the survey details.
Output
pages full type
pages full type
list
responses.list
List a survey response ids, filtered by date or status. Read one to see the answers
Risk: read
{ data } where each entry is only an id and a link. Use responses.listBulk for the answers. status takes completed, partial, overquota or disqualified.
Output
links full type
links full type
data full type
data full type
listBulk
responses.listBulk
List survey responses with their answers in one call, up to 100 a page
Risk: read
{ data } with each response’s pages, questions and answers. per_page goes up to 100. simple: true adds the question and answer text alongside the ids. collector_ids, page_ids and question_ids narrow what comes back.
Output
links full type
links full type
data full type
data full type
Surveys
create
surveys.create
Create an empty survey, or a copy of a template or an existing survey
Risk: write
from_template_id copies a template, and from_survey_id copies an existing survey; without either the survey is empty and needs a page and a question before it can record a response.
Output
delete
surveys.delete
Delete a survey and its responses. There is no undo and the questions go with it
Risk: destructive · Irreversible
{ survey_id, deleted: true }. The pages, questions and responses go with it.
Output
get
surveys.get
Read one survey with its counts, links and response count
Risk: read
response_count is present only when the list route was asked for it with include.
Output
getDetails
surveys.getDetails
Read a survey with every page and question, including choice ids and values
Risk: read
pages full type
pages full type
list
surveys.list
List surveys in last-modified order, filtered by title, folder or modification date
Risk: read
{ data, page, per_page, total, links }. sort_by takes title, date_modified or date_created, and sort_order is ASC or DESC. include takes a comma-separated list such as response_count,date_created to add those fields, and folder_id, title and the two modification dates narrow the list.
Output
links full type
links full type
data full type
data full type
listCategories
surveys.listCategories
List the survey categories available for the language
Risk: read
{ data }, the categories a survey can be filed under for language.
Output
links full type
links full type
data full type
data full type
listLanguages
surveys.listLanguages
List the languages a survey can be written in
Risk: read
{ data }, the languages a survey can be written in.
Output
links full type
links full type
data full type
data full type
listTemplates
surveys.listTemplates
List the survey templates, optionally filtered by language or category
Risk: read
{ data } of surveys, each a template. language and category narrow the list.
Output
links full type
links full type
data full type
data full type
replace
surveys.replace
Replace a survey wholesale. Fields left out reset to their defaults, so prefer update
Risk: destructive · Irreversible
surveys.update for a single change.
update
surveys.update
Change a survey title, nickname, language, button text, variables or folder
Risk: write
buttons_text sets the four button labels, and custom_variables is a map of name to label.
Users
getMe
users.getMe
Read the account the token belongs to, which is the cheapest connection check
Risk: read
account_type. This is the cheapest way to confirm a connection works. The plan decides how many responses the API returns.
Output
Webhooks
create
webhooks.create
Subscribe a URL to an event on a survey or collector. SurveyMonkey then POSTs to it
Risk: write
event_type is one of the twelve documented events. object_ids lists the surveys or collectors to watch, and is omitted for survey_created, which fires on a survey that does not exist yet. authorization is a value SurveyMonkey sends back as a header on every delivery.
Output
delete
webhooks.delete
Delete a webhook subscription. The URL stops receiving events
Risk: destructive · Irreversible
{ webhook_id, deleted: true }. The URL stops receiving events.
Output
get
webhooks.get
Read one webhook subscription
Risk: read
list
webhooks.list
List the webhooks on the account and what they subscribe to
Risk: read
{ data } of webhooks and what each subscribes to.
Output
links full type
links full type
data full type
data full type
update
webhooks.update
Change a webhook event, target objects or subscription URL
Risk: write
object_ids, so when you leave them out the plugin reads the webhook first and resends its current ones.
Output