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

Answers

get

answers.get Read one answer with its question, chosen option, sentiment and comment Risk: read
Input Output

answers.search Search answers by date range and filters such as sentiment, across every survey Risk: read
Input A POST because it takes a filter list and date range, but its next links are followed with a GET.
Output

update

answers.update Change an answer’s chosen option, comment or sentiment. The question and survey it belongs to are fixed Risk: write
Input Output

Customers

bulk

customers.bulk Queue many customer upserts in one request. The answer carries a request_id rather than the stored records, because the write is queued Risk: write
Input Queued rather than applied: the answer carries a request_id and a message, not the stored records.
Output

create

customers.create Create or update a customer. Simplesat matches on external_id or email, so it is an upsert rather than a plain create Risk: write
Input An upsert: Simplesat matches on external_id or email rather than always inserting, so send one of them. The schema rejects a customer with neither. Output

get

customers.get Read one customer by their Simplesat id, with their tags and custom attributes Risk: read
Input Output

list

customers.list List customers with filters for when they were created or modified and whether they are subscribed; follow next for the following page Risk: read
Input Pass the path from a previous page as next. Every list answers { next, previous, count, results }, and next is a same-host path the plugin checks before use. Output

update

customers.update Update one customer by their Simplesat id, replacing the fields sent Risk: write
Input Output

Questions

list

questions.list List the questions behind the surveys, filtered by survey or metric, with their types and choices Risk: read
Input Filter by survey_id, or by metric such as csat, to see the questions behind a survey. Output

Responses

create

responses.create Create a response, or update the one that already matches it. created backdates it, which is how a survey answered elsewhere is imported Risk: write
Input Creates a response or updates the one that already matches it. created backdates it, which is how a survey answered elsewhere is imported. A comment sent with a multiple-choice answer is not stored (seen live); put written feedback on the follow-up comment question.
Output

get

responses.get Read one response with its survey, customer, answers and team members Risk: read
Input Output

search

responses.search Search responses by date range and filters such as customer email, with each response’s answers and team members Risk: read
Input
Output

update

responses.update Update one response by id. The body takes the same shape as a create, so the whole response is sent back Risk: write
Input
Output

Surveys

email

surveys.email Send a survey to one customer by email. This notifies a real person, and the survey is identified by its token Risk: destructive
Input Takes the survey_token from surveys.list, not the numeric survey id, and schedules a real email to the customer.
Output

list

surveys.list List the surveys on the account with their metric, type and survey_token Risk: read
Input Output

Team Members

create

teamMembers.create Create or update a team member, which is how a response is attributed to the person who handled it Risk: write
Input Output

get

teamMembers.get Read one team member with their groups and custom attributes Risk: read
Input Output