Change Log

Changes

11 Mar 2022

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.

7 Jan 2022

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.

3 December 2022

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.

21 September 2021

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.

14 July 2021

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.

9 July 2021

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.

1 July 2021

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.

6 May 2021

Updated people/person terminology to contact(s)

List of affected API endpoints:
  • 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
2 March 2021

Added optional parameter

Added include-delay (optional) to /api/v1/stats

21 February 2018

Updated Documentation

Added additional information about rate limiting.

20 February 2018

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.

9 January 2018

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.

9 November 2017

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.)

21 August 2017

Sent Statistics

Added new API endpoint
GET /api/v1/sentstats

10 August 2017

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.

29 June 2017

Bulk Add/Trigger

Examples to bulk add contacts and or trigger a survey

11 Jan 2016

New Help Docs

Added new API help docs with working examples.

23 Dec 2015

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

23 Dec 2015

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.