Get customers
Answer customers
Work for you
Reach people
Give agents tools
Run and ship
Manage customers, feedback, surveys and team members
Get answer by ID. Get an answer by ID. Required scopes: `read answers`
1 field
Update answer by ID. Update an answer by ID. One of `choice`, `choices`, or `comment` is required. Required scopes: `write answers`
7 fields
Search answers. Search for answers. Required scopes: `read answers` Accepted `comparison` values are: - `is` - `is_not` - `contains` - `does_not_contain` - `is_unknown` - `has_any_value` Accepted `key` values are: - `choice_value` - `comment` - `metric` - `sentiment` - `survey` (token)
5 fields
Update customer by ID. Update a customer by ID. Updating the `custom_attributes` or `tags` fields will overwrite any existing values. Customers accept arrays in `custom_attributes`. Required scopes: `write customers`
Get customer by ID. Get a customer by ID. Required scopes: `read customers`
Create or update customer. Create or update a customer. If the customer with the specified email address already exists, the existing customer will be updated. Updating the `custom_attributes` or `tags` fields will overwrite any existing values. Customers accept arrays in `custom_attributes`. Required scopes: `write customers`
List customers. Get a paginated list of customers with optional filtering by creation/modification dates and subscription status. Required scopes: `read customers`
Get team member by ID. Get a team member by ID. Required scopes: `read team members`
Create or update team member. Create or update a team member. If the team member with the specified email address already exists, the existing team member will be updated. Updating the `custom_attributes` field will overwrite any existing custom attributes. Required scopes: `write team members`
4 fields
Get response by ID. Get a response by ID. Required scopes: `read responses`
Search for responses. Search for responses. Required scopes: `read responses` Accepted date filters are: - `created_start_date` - `created_end_date` - `modified_start_date` - `modified_end_date` Accepted `comparison` values are: - `is` - `is_not` - `contains` - `does_not_contain` - `is_unknown` - `has_any_value` Accepted `key` values are: - `choice_value` - `collaborator` - `company` - `comment` - `customer` (name) - `customer.email` - `ip` - `metric` - `sentiment` - `source` - `survey` (token) - `tag` - `team_member` (name) - `team_member.email` - `team_member.id` (external_id) - `ticket_id` (external_id) - `customer.attribute` (add the `attribute` field to the filter to specify the attribute to filter on) - `ticket.attribute` (add the `attribute` field to the filter to specify the attribute to filter on)
9 fields
Create or update response. Create or update a response. If the response with the specified external ID already exists, the existing response will be updated. When creating a new response, the `survey_id` and `answers` fields are required. The `answers` array should have at least one item with the `question_id` and either a `choice` or `choices` field. The customer and team members will be created if they do not already exist with the specified email address. Otherwise, the response will be linked to the existing customer and team member. Team members and customers without emails will be ignored. Updating any `tags` or `custom_attributes` field will overwrite any existing values. When updating a response none of the fields are required, but at least one field must be provided. Required scopes: `write responses`
8 fields
Update response by ID. Update a response by ID. Updating the `tags` field, or any of the `custom_attributes` fields will overwrite any existing values. Required scopes: `write responses`
List surveys. List active surveys, newest first. Archived surveys are not returned. Required scopes: `read surveys`
3 fields
Send survey by email. Send a survey email. Only survey tokens of surveys with survey type `event_based_email` are accepted. Required scopes: `write surveys`
List questions. List questions. Required scopes: `read questions`