Answers
get
answers.get
Read one answer with its question, chosen option, sentiment and comment
Risk: read
question full type
question full type
survey full type
survey full type
search
answers.search
Search answers by date range and filters such as sentiment, across every survey
Risk: read
filters full type
filters full type
results full type
results full type
update
answers.update
Change an answer’s chosen option, comment or sentiment. The question and survey it belongs to are fixed
Risk: write
question full type
question full type
survey full type
survey full type
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
customers full type
customers full type
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
get
customers.get
Read one customer by their Simplesat id, with their tags and custom attributes
Risk: read
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
next. Every list answers { next, previous, count, results }, and next is a same-host path the plugin checks before use.
Output
results full type
results full type
update
customers.update
Update one customer by their Simplesat id, replacing the fields sent
Risk: write
Questions
list
questions.list
List the questions behind the surveys, filtered by survey or metric, with their types and choices
Risk: read
results full type
results full type
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
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.
answers full type
answers full type
team_members full type
team_members full type
ticket full type
ticket full type
customer full type
customer full type
ticket full type
ticket full type
team_members full type
team_members full type
customer full type
customer full type
answers full type
answers full type
get
responses.get
Read one response with its survey, customer, answers and team members
Risk: read
ticket full type
ticket full type
team_members full type
team_members full type
customer full type
customer full type
answers full type
answers full type
search
responses.search
Search responses by date range and filters such as customer email, with each response’s answers and team members
Risk: read
filters full type
filters full type
results full type
results full type
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
answers full type
answers full type
team_members full type
team_members full type
ticket full type
ticket full type
customer full type
customer full type
ticket full type
ticket full type
team_members full type
team_members full type
customer full type
customer full type
answers full type
answers full type
Surveys
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
customer full type
customer full type
list
surveys.list
List the surveys on the account with their metric, type and survey_token
Risk: read
results full type
results full type
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
get
teamMembers.get
Read one team member with their groups and custom attributes
Risk: read