Skip to main content
New to Corsair? See API access, authentication, and error handling.

Collectors

create

collectors.create Create a weblink or email collector for a survey, which is what gives it a public link Risk: write
Input Answers the created collector. 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
Input Answers 200 with an empty body and reports { 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
Input Answers one collector with its link, status and settings. Output

list

collectors.list List the collectors of a survey with their links and status Risk: read
Input Answers { data } of collectors. include adds their messages, name filters by name, and start_date plus end_date filter by creation. Output

update

collectors.update Change a collector settings, or open and close it by status Risk: write
Input Sends PATCH, so only the fields you pass change. 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
Input Answers the new list. name defaults to a copy of the original name. Output

create

contactLists.create Create an empty contact list Risk: write
Input Answers the created list. A list starts empty; contacts are on the account and adding them is a separate resource. Output

delete

contactLists.delete Delete a contact list. The contacts on it stay on the account Risk: destructive · Irreversible
Input Answers 200 with an empty body and reports { contact_list_id, deleted: true }. The contacts on it stay on the account. Output

get

contactLists.get Read one contact list Risk: read
Input Answers one contact list. Output

list

contactLists.list List the contact lists on the account Risk: read
Input Answers { data } of contact lists on the account, 50 a page by default. Output

merge

contactLists.merge Copy every contact from list_id into this list. list_id keeps its contacts Risk: write
Input Copies every contact from 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
Input Sends PATCH with 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
Input Wraps the list in 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.
Output

create

contacts.create Create a contact with a name and an email or a phone number Risk: write
Input Answers the created contact. Both names are required, and so is an email or a phone number. This creates the contact on the account; a contact list is a separate resource. Output

delete

contacts.delete Delete a contact. It stops receiving invites and leaves every contact list Risk: destructive · Irreversible
Input Answers 200 with an empty body and reports { 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
Input Answers one contact with its custom_fields and status. Output

list

contacts.list List contacts on the account, filtered by status or a search field Risk: read
Input Answers { 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

listFields

contacts.listFields List the custom contact fields and their labels Risk: read
Input Answers { data } of the custom contact fields, with the label to show and the id to use as a key in custom_fields. Output

update

contacts.update Change a contact name, email, phone number or custom fields Risk: write
Input Sends PATCH, so only the fields you pass change. custom_fields replaces the whole map. Output

updateField

contacts.updateField Rename a custom contact field Risk: write
Input Sends PATCH with 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
Input Sends the title as a lowercase 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
Input Answers { data } of survey folders. Output

Messages

create

messages.create Draft an invite or reminder for an email collector. Nothing is sent until send is called Risk: write
Input Answers the drafted message. 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
Input Answers one message subject and body. Output

list

messages.list List the invite and reminder messages of a collector Risk: read
Input Answers { data } of the collector’s messages. Output

send

messages.send Send a message to every recipient on it. This mails real people, so check the recipients first Risk: destructive
Input Sends the message to every recipient on it. This mails real people, so list the recipients first. 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
Input Sends PATCH. A change is only possible before the message is sent. Output

Pages

create

pages.create Add a page to a survey, optionally at a given position Risk: write
Input Answers the created page. position is 1-based; omitting it appends the page. Output

delete

pages.delete Delete a page and the questions on it. There is no undo Risk: destructive · Irreversible
Input Answers 200 with an empty body and reports { 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
Input Answers one page with its question_count. Output

list

pages.list List the pages of a survey in their order Risk: read
Input Answers { data } in page order. A survey always has at least one page once it has questions. Output

update

pages.update Change a page title, description or position Risk: write
Input Sends PATCH, so only the fields you pass change. position reorders the page within the survey. Output

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
Input Answers the created question. 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.
Output

delete

questions.delete Delete a question and the answers recorded for it. There is no undo Risk: destructive · Irreversible
Input Answers 200 with an empty body and reports the three ids. The answers recorded for the question go with it. Output

get

questions.get Read one question with its choices and settings Risk: read
Input Answers one question with its choices, required rule and validity settings. Output

list

questions.list List the questions on one page of a survey Risk: read
Input Answers { data } in question order. Each question carries its family, subtype, headings and, for a choice question, its choices. Output

update

questions.update Change a question heading, position, required rule, visibility or choices Risk: write
Input Sends PATCH, so only the fields you pass change. visible: false hides the question without deleting it, and the answers already recorded stay.
Output

Recipients

bulkCreate

recipients.bulkCreate Add up to a few hundred recipients to a message in one call Risk: write
Input Wraps the list in 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.
Output

create

recipients.create Add one recipient to a message by email address Risk: write
Input Answers the created recipient. The email has to look valid, and the message must not have been sent yet. Output

list

recipients.list List the recipients on one message with their delivery status Risk: read
Input Answers { data } with each recipient’s mail_status and survey_response_status, which is how you tell who has answered. Output

Responses

create

responses.create Record a response through a collector, as data entry. Nothing is mailed to a respondent Risk: write
Input Posts to /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.
Output

delete

responses.delete Delete one response and its answers. The counts on the survey change and there is no undo Risk: destructive · Irreversible
Input Answers 200 with an empty body and reports { 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
Input Deletes every response the collector gathered and reports { 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
Input Answers one response with its pages, questions and answers. Each answer carries a choice_id, row_id, col_id or other_id, which you map to text with surveys.getDetails. Output

getDetails

responses.getDetails Read one response with its answers and the page and question detail Risk: read
Input Answers one response with the same structure as responses.get plus the question detail. responses.get is enough when you already cached the survey details. Output

list

responses.list List a survey response ids, filtered by date or status. Read one to see the answers Risk: read
Input Answers { 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

listBulk

responses.listBulk List survey responses with their answers in one call, up to 100 a page Risk: read
Input Answers { 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

Surveys

create

surveys.create Create an empty survey, or a copy of a template or an existing survey Risk: write
Input Answers the survey with an empty page list. 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
Input Answers 200 with an empty body, so the plugin reports { 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
Input Answers one survey. 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
Input Answers the survey with every page and question, including each choice’s id and text. This is the call to make before reading answers, because a response carries choice ids rather than choice text. Output

list

surveys.list List surveys in last-modified order, filtered by title, folder or modification date Risk: read
Input Answers { 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

listCategories

surveys.listCategories List the survey categories available for the language Risk: read
Input Answers { data }, the categories a survey can be filed under for language. Output

listLanguages

surveys.listLanguages List the languages a survey can be written in Risk: read
Input Answers { data }, the languages a survey can be written in. Output

listTemplates

surveys.listTemplates List the survey templates, optionally filtered by language or category Risk: read
Input Answers { data } of surveys, each a template. language and category narrow the list. Output

replace

surveys.replace Replace a survey wholesale. Fields left out reset to their defaults, so prefer update Risk: destructive · Irreversible
Input Sends PUT, which replaces the survey. A field you leave out resets to its default, so use surveys.update for a single change.
Output

update

surveys.update Change a survey title, nickname, language, button text, variables or folder Risk: write
Input Sends PATCH with only the fields you pass, so everything else stays. buttons_text sets the four button labels, and custom_variables is a map of name to label.
Output

Users

getMe

users.getMe Read the account the token belongs to, which is the cheapest connection check Risk: read
Input: empty object Answers the account the token belongs to, with its 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
Input Answers the created webhook. 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
Input Answers 200 with an empty body and reports { webhook_id, deleted: true }. The URL stops receiving events. Output

get

webhooks.get Read one webhook subscription Risk: read
Input Answers one webhook subscription. Output

list

webhooks.list List the webhooks on the account and what they subscribe to Risk: read
Input Answers { data } of webhooks and what each subscribes to. Output

update

webhooks.update Change a webhook event, target objects or subscription URL Risk: write
Input Sends PATCH, so only the fields you pass change. SurveyMonkey rejects a patch without object_ids, so when you leave them out the plugin reads the webhook first and resends its current ones. Output