November 2017

  • 2017-11-22: Property added for user response object new
    The property avatar is added to the user response object.
  • 2017-11-22: Priority of case becomes an object with more information version 20171122 breaking change
    Only passing the priority of a case was not enough. From now on you will also receive the name and color of the priority.
  • 2017-11-01: Properties type change for contact response object bug fix
    The properties contact.date.added and contact.date.updated would sometimes be returned as a string representation of the date instead of a UNIX timestamp that was described in the documentation.

October 2017

  • 2017-10-31: new endpoint for getting the context of a mention new
    You can use the /{account_id}/inbox/context endpoint to get more context about a mention (the previous conversations with the customer, notes added by users, etc.).
  • 2017-10-25: Added contact.permalink property to contact response object new
    We have added the property contact.permalink to the contact object. This object contains a link straight to the contact's details in the CX Social tool, and can be used to link to in your apps.
    Meanwhile we have taken the opportunity to improve documentation on all of the contact object's properties.
  • 2017-10-25: Removed obsolete contact object fields change
    We have removed the properties contact.url, contact.address.street, contact.address.number, contact.address.zip from the contact object since they are unavailable to fill in in the interface and are thus obsolete.
  • 2017-10-25: Users with a "Free Analytics User Role" no longer have API Access breaking change
    Some account plans have the ability to create unlimited "free analytics" users. These are users with limited view rights in the application. We are disabling API access for these users since that is not intended use for this use case, and since by creating extra of these users the Rate Limiting restrictions could be circumvented, which can have negative impact on the site's performance.
  • 2017-10-06: We've added an extra field on the mention object new
    We have added the property extra_fields to every returned mention object.
  • 2017-10-02: Changes to updating a contact's country new
    When updating a contact via the /{account_id}/inbox/contact/{service}/{service_id} endpoint, you can now supply both address.country.name and/or address.country.code as updates. When `code` is set, that one will get precedence, or when `name` is set for the country, we'll look up the provided name in our English list of countries to find the corresponding code. If you provide a country name we don't recognize, an error of type invalid_parameter will be returned. We use ISO 3166-1 alpha-2 for country codes.
  • 2017-10-02: Overwrite all custom attributes new
    You can now overwrite all existing custom attributes of a contact by new provided values using the new customattributes_edit_mode:overwrite option parameter for the /{account_id}/inbox/contact/{service}/{service_id} endpoint. This edit mode will remove all existing attributes, and set the new provided ones. (Similar to the tags_edit_mode option.)

September 2017

  • 2017-09-27: Fetch only contacts with certain tag new
    You can now restrict contacts returned by the /{account_id}/inbox/contacts endpoint so only contacts with a certain tag are returned by supplying a filter argument, and filter on a contact tag, with e.g. contacttag:yourtagname.
  • 2017-09-25: Fetch only updated contacts new
    You can now restrict contacts returned by the /{account_id}/inbox/contacts endpoint so only contacts updated after a certain date are returned.
  • 2017-09-25: We've added sorting options for contacts endpoint new
    You can now choose how you want the list of contacts returned by the /{account_id}/inbox/contacts endpoint to be sorted, by creation date or by last update.
    We have also added the properties date.added and date.updated to every returned contact object.
  • 2017-09-21: Use canned responses when publishing mention. new
    Selecting a canned response for a mention is now possible using the /{account_id}/publisher/add endpoint.
  • 2017-09-21: New endpoint for getting the folders of the canned responses of an account. new
    Getting the folders of the canned responses of an account is now possible using the /{account_id}/settings/canned_responses_folders endpoint.
  • 2017-09-18: New endpoint for getting the canned responses of an account. new
    Getting the canned responses of an account is now possible using the /{account_id}/settings/responses endpoint.
  • 2017-09-07: New endpoint for marking a todo-item as done or to do during a crisis new
    Marking a todo-item done or undone during a crisis is now possible using the /{account_id}/crisis/todo endpoint.
  • 2017-09-07: New endpoint for enabling or disabling a crisis plan new
    Enabling or disabling of a crisis plan is now possible using the /{account_id}/crisis/event endpoint.
  • 2017-09-07: Crisis Plan Object new fields new
    We've added the summary of a Crisis Plan Object.

June 2017

  • 2017-06-20: Tag Object new fields new
    The Tag Object visible field and category_model_tag field, have been added.

March 2017

  • 2017-03-17: Fetch contact data by contact id new
    You can now also fetch contacts via their contact.id, not only via a combination of the social service & service id. The new endpoint /{account_id}/inbox/contact/{contact_id} works in exactly the same was as the existing /{account_id}/inbox/contact/{service}/{service_id} endpoint.
  • 2017-03-17: Changes to updating a contact breaking change
    The endpoint to update a contact /{account_id}/inbox/contact/{service}/{service_id} has been updated to support updating the contact tags and updating multiple custom attributes at once. For this we had to make a few breaking changes in how you update address data, and custom attributes. We've updated the examples.
  • 2017-03-17: New endpoint for getting a list of contacts new
    Getting the full list of contacts of an account is now possible using the /{account_id}/inbox/contacts endpoint.
  • 2017-03-17: New endpoint for getting the custom attributes of an account. new
    Getting the list of custom attributes of an account is now possible using the /{account_id}/settings/customattributes endpoint.

January 2017

  • 2017-01-26: New endpoint for getting the crisis plans of an account. new
    Getting the crisis plans of an account is now possible using the /{account_id}/crisis/plans endpoint.

June 2016

May 2016

  • 2016-05-26: Date filtering for /{account_id}/publisher/mentions bug fix
    The date filter parameters date_from and date_to of the /{account_id}/publisher/mentions only had effect when you filtered on mentions with status "posted" (i.e. your publisher history). We have fixed that the parameters now always have effect.

April 2016

March 2016

February 2016

January 2016

  • 2016-01-19: New Actionlink Object field new
    The Actionlink Object field post_params has been added. This optional field will be filled when a POST action link requires specific arguments.
  • 2016-01-08: Email user on assignment version 20160108 new
    We've added the option to send out an email when a mention is assigned using the /{account_id}/inbox/mention/{topic_id}/{id} endpoint to update a mention.
  • 2016-01-05: New Mention Object field new
    We've added the user tags for the author of a Mention Object.

December 2015

  • 2015-12-31: New endpoint to delete a mention new
    We have added support for deleting a Mention Object. Make a DELETE http request to /{account_id}/inbox/mention/{topic_id}/{id} to remove the mention from CX Social. Optionally you can also request to have the mention deleted from Facebook/Twitter, etc.
    When requesting mentions you will now also get back an Actionlink Object with key: delete.
  • 2015-12-31: New Actionlink Object field new
    The Actionlink Object field http_method has been added. This field describes which http method you should use when making the request to the link. This has been added to distinguish between GET, POST and DELETE requests.
  • 2015-12-31: Support for changing sentiment of Mention Object new
    It's now possible to update the sentiment of a single Mention Object. Make a POST request to /{account_id}/inbox/mention/{topic_id}/{id} with e.g. updates={"message":{"sentiment":"positive"}}. More details in this example.
  • 2015-12-28: Removed notes from Contact Object breaking change
    The field notes of the Contact Object has been removed, in favour of using notes on Mention Objects
    If you want to add unstructured information to a contact you can use the comments field of the Contact Object.
  • 2015-12-24: New Mention Object fields documentation new
    The Mention Object field entities, has been documented. This array can contain the following objects;
  • 2015-12-24: Adding notes to Publisher Mention Object new
    You can now add notes to the Publisher Mention Object via the API. Make a POST request to /{account_id}/publisher/mention/{id} with updates={"actions":[{"type":"note","extra":"Text of the note to be added goes here."}]}. More details in this example.
  • 2015-12-24: New Publisher Mention Object fields new
    The object actions has been added to the Publisher Mention Object. This array contains Mention Action Objects similar to Action objects of Mention Objects.
  • 2015-12-22: New API endpoint for viewing the Security Audit Log new
    Via the new /{account_id}/security/audit endpoint you can fetch all security audit logs for a certain account. Full documentation can be found on the Endpoint documentation page.
  • 2015-12-11: New Mention Object fields new
    The object timestamps has been added to the Mention Object. This array can contain the following properties:
    • response_time: The time between date.published and the first reply (if any), in seconds.
    • response_time_during_bh: The time (during business hours) between date.published and the first reply (if any), in seconds.
    • resolve_time: The time between date.published and the first resolve date (if any), in seconds.
    • resolve_time_during_bh: The time (during business hours) between date.published and the first resolve date (if any), in seconds.
    • handle_time: The total time spent handling this message, in seconds.

September 2015

January 2015

  • 2015-01-20: New API Endpoint for fetching mailboxes configuration new
    Via the new /{account_id}/inbox/mailboxes endpoint you can get the configuration details of all mailboxes configured for an account. The configuration of eg. a certain mailbox folder can then be used to decide on which parameters to send to the /{account_id}/inbox/mentions API endpoint to fetch mentions for a certain smart folder.
  • 2015-01-16: We have created a FAQ page new
    Several of the questions people ask when starting out with our API are answered here.
  • 2015-01-06: New API Endpoint for fetching account history new
    Via the new /{account_id}/settings/history endpoint you can fetch the audit log of all configuration changes to an account. You can filter on type, topic and/or user.

November 2014

  • 2014-11-21: Dashboard endpoint now also returns layout details new
    The dashboard_widget response object now also includes details about the width, height and positioning of each widget on the dashboard. So if you're using the /{account_id}/dashboards/export/{dashboard_id} endpoint you will now also receive these extra details.
    We also made sure the widgets in the resultset are sorted in a more logical way.

October 2014

  • 2014-10-29: Sorting inbox mentions new
    Our /{account_id}/inbox/mentions endpoint now has an extra (optional) sort parameter to retrieve mentions in the order you like; from new to old, from old to new, by latest edit date, etc.

September 2014

  • 2014-09-08: Better sentiment detection API new
    Our /tools/sentiment endpoint has been updated to use our improvement sentiment detection algorithm, and also accepts an optional language parameter if you want to bypass our automatic language detection.

July 2014

  • 2014-07-23: New Mention Object field new
    The field source.service, showing if a mention is from "twitter", "facebook", or other known service has been added to the Mention Object. This is now recommended over the source.type field which contains more internal names for our services (eg. SearchProviderTwitter for Twitter).

June 2014

  • 2014-06-03: Creating drafts and sending messages for approval new
    It is now possible add messages to CX Social to be published on your social profiles. Full documentation and a few examples can be found on the Endpoint documentation page.
    Note: We cannot expose real publishing functionality in our API per third-party terms of service agreements (eg. Twitter API Rules), so only creating drafts, or queueing messages for approval is exposed to non-CX Social applications.
    (This is a first version of this API-call; you cannot yet attach images to the posts. We would love to hear your feedback.)

February 2014

  • 2014-02-04: Updating mentions new
    It is now possible to add notes to mentions via the API, or to add/delete one or more tags from a mention without affecting the current ones. See the examples on the Endpoint documentation page.
  • 2014-02-04: Several new endpoints new
    We have added several new endpoints:
    1. Lists all of the tags of a certain account, details.
    2. List details of a certain social profile, details.
    3. Return a list of mentions (or a single mention) waiting for approval, messages in draft, details here and here.

January 2014

  • 2014-01-15: Mention changes breaking change
    The field assignment of the Mention Object has been split into assignment.user_ids and assignment.comment.

November 2013

  • 2013-11-29: Field Expansion support new
    API endpoints returning data (GET) now all support a "fields" parameter (click "Advanced" in the API Test Console to try it out), that controls which data will be returned. This way you can select only the fields you're interested in. This optimization allows you to save on bandwith and can speed up response times of our API. Field expansion works in the same way as described here (under the header "Making Multiple Requests in a Single Call").
    Try it with sending ?fields=name,plan,projects.limit(1).fields(name,topics) to the /me/accounts endpoint.
    More documentation will follow.
  • 2013-11-29: Using ETags new
    For speeding up requests to our API you can now use ETags to know if something has changed since you last request. This works in the same way as eg. the Facebook Graph API, documented here.
    When doing requests to the CX Social API with the If-None-Match request header, the Response Envelope will also contain a field meta.etag with the etag for that response.
    More documentation will follow.
  • 2013-11-29: OAuth 2.0 grant_type=password new
    We now support the OAuth 2.0 grant type "password" for selected applications. Get in touch to get access to this type of authentication.
  • 2013-11-27: Envelope changes breaking change
    The fields meta.error, meta.error_description and meta.error_details of the Response Envelope have been removed. Non-fatal errors (and warnings) will now be of type message in the meta.messages field.

June 2013

May 2013

  • 2013-05-29: XML Support new
    Include a parameter ?format=xml if you want the response to be in the XML format, instead of the default JSON. Click "Advanced" in the API Test Console to try it out.