- Quick Start
- Send Survey
- Get Contact
- Remove Contact
- Delete Contact (GDPR)
- Get Unsubscribed
- Get Responses
- Get NPS
- Sent Statistics
- Historical Stats
- Deactivate All
- Bulk Add with CSV
- Inapp Surveys
- Bulk Add/Send
Change Log
Changes
Get Responses - Salesforce
If you are using our Salesforce integration, the responses will now include sfaccount, sfcontactid, sfcaseid, and sfleadid fields.
Clarification of custom data fields
Updated API paged to clarify how to use custom data fields with `_c` suffix. Also improved formatting and readability.
Get Responses - Advanced Case Management
If you have Advanced Case Management, the responses will now include a case_assigned_user field.
Get Responses and NPS
We've added new filtering options to our /responses
and /getnps endpoints.
Now, you can use filters[] and values[] in your requests.
Historical Stats
If you are using a combination of metrics in the leading question of your surveys, the NPS score returned in the Historical Sent Stats was previously miscalculated and may have returned a lower score as it considered 5 Star and CSAT scores.
The classification as Promoters, Passives and Detractors has also been affected and is now working based on the standard classifications which you can read more about on the Help pages. “csat” and “fivestar” averages have been added to the response object.
Add pagination for unsubscribe API
New documentation is now available. To see how you can use pagiantion query through unsubscribe API go to ‘Get Unsubscribed’ in the API documentation.
Bulk Add with CSV
New documentation is now available. To see how you can add contacts from a CSV file through API go to ‘Bulk Add with CSV’ in the API documentation.
Get Responses
The /responses endpoint requires your clients to follow redirects now when requesting more than 999 responses. This number might change in the future, so please make sure to enable redirects for your client.
We also serve an error now when requesting more than 50,000 responses per request.
If you need to request more than 50,000 responses you will need to make multiple API calls.
Get Responses
The /responses endpoint requires your clients to follow redirects now when requesting more than 2000 responses. We also serve an error now when requesting more than 50,000 responses per request.
If you need to request more than 50,000 responses you will need to make multiple API calls.
Deactivate All
The Deactivate All endpoint was changed to handle possible timeouts through redirection. Please ensure your implementation allows redirection and check our updated documentation for further details.
Get Responses
The API help documentation was updated to include details on limitations and redirection that will be enforced from October 2021. Please update your API implementation prior to the switch.
Change to Bulk Add/Send
The /contacts/add endpoint is now asynchronous.
We will accept valid data and immediately return a HTTP 201 ACCEPTED or an error.
The data will then be processed asynchronously by us as described in the updated
Bulk Add/Send API documentation
.
No contact specific data will be provided by the endpoint.
Updated people/person terminology to contact(s)
-
deprecated /api/v1/person/add, is now /api/v1/contacts/add
- deprecated people parameter, is now contacts
-
deprecated /api/v1/person/trigger, is now /api/v1/contact/trigger
- deprecated parameter addperson, is now addcontact
- deprecated /api/v1/people/deactivateall, is now /api/v1/contacts/deactivateall
- deprecated /api/v1/person/unsubscribed, is now /api/v1/contacts/unsubscribed
- deprecated /api/v1/person/get, is now /api/v1/contact/get
- deprecated /api/v1/person/remove, is now /api/v1/contact/remove
-
/api/v1/sentstats
- deprecated filter(s) parameter person_id, is now contact_id
-
/api/v1/responses
- deprecated property person_id, added property contact_id
Added optional parameter
Added include-delay (optional) to /api/v1/stats
Updated Documentation
Added additional information about rate limiting.
HTTP response code with invalid/missing API key
When sending an invalid (or no) API key, we are now responding with
HTTP 401 UNAUTHORIZED instead of HTTP 200 OK.
Added and modified stats.
Added 'delivered' and 'surveys_delivered_responded_percent' to the response data of /api/v1/stats.
Added 'delivered' and changed how 'responserate' is calculated for /api/v1/sentstats.
This now matches the dashboard calculation, delivered/responded.
Rate Limits
Now enforcing some limits on API usage. If you receive a 429 response, you should lower the rate at which you are sending API requests. (There is some information about the limits and current usage included in the headers.)
Sent Statistics
Added new API endpoint
GET /api/v1/sentstats
HTTP Access Will Be Removed (Use HTTPS Instead)
Using HTTP (i.e. unencrypted plain-text communication) to access API resources has, up until now, been possible (but not recommended or documented). That access is now deprecated, and will be removed in the near future. We will only support HTTPS/TLS access to API resources. (We eventually would like to set HSTS headers to reflect this fact.)
This change is to bring our API into line with industry best practices. This should have no impact on existing integrations that follow the documentation (which shows HTTPS endpoints). Requests for HTTP resources will be redirected to their HTTPS equivalent via a 307 response.
Bulk Add/Trigger
Examples to bulk add contacts and or trigger a survey
New Help Docs
Added new API help docs with working examples.
MailChimp WebHook
Update AskNicely automatically from MailChimp when a contact is updated or addeded to a MailChimp list. This allows a triggered workflow vs a sync and schedule workflow. See Settings>MailChimp Webhook
Email to Survey
You can now use our "Email to Survey" functionality which allows you to send us a specially formatted email
which can be used to trigger a survey to a customer.
This is super handy when dealing with other cloud apps that can sometimes trigger an email when an event
occurs.
See Settings > Email to Survey.