These docs are for v0.1.0. Click to read the latest docs for v1.0.0.
deprecated

[Core API] Topics renamed to Links

In order to avoid confusion between the API documentation and the user-facing feature, we are renaming Topics-related endpoints to "Links". This new naming clarifies the use case of the feature, and is more consistent with our in-app naming. No underlying functionality or resource IDs will change, but the the legacy Topics routes are now deprecated and will be removed October 31st, 2021. If you are currently relying on Topics, you'll need to make some small updates before the removal date as described below:

fixed

[Core API] Contacts access check

In some limited cases, contacts not visible in the Contact Manager would be accessible via the Public API when using a contact ID alias (eg: alt:email:[email protected]).
This fix now ensures that contacts returned using this method can be found in the Contact Manager.

[Core API] Topics support

Added endpoints for listing, creating, and updating topics. Also added support for adding and removing topics from conversations. Topics (or Links as they are known in-app) are highly recommended when trying to tie conversations to external systems — for example linking bugs, feature requests, work orders, shipments, loans, trips etc.. They are similar to Tags except that they are unique across your entire instance of Front (not just the same Team), and allow users to access the related resource via a unique URL.

fixed

[Core API] Enforce feature access

A bug in our Core API server was letting traffic to some endpoints to go through despite the feature not being accessible to their plan.

removed

[Core API] `prev` Pagination Field Removal

[Core API] Resource-specific custom fields

Front is introducing resource-specific custom fields. In addition to Contacts, custom fields can now be added to Inboxes and Teammates.

improved

[Channel API] Message import improvements

Starting May 31, 2021, important usability improvements will be introduced to the Channel API. For developers of existing Channel API integrations, the changes are purely additive and no technical changes should be necessary. Nevertheless, we highly recommend taking advantage of these improvements to conserve API calls and simplify code. The changes can be summarized as follows:

added

[Core API] Search Conversations Endpoint

Added a new Search conversations endpoint to find conversations based on a variety of parameters. You can use the Search API to perform workflows such as finding all conversations referencing a particular customer and pushing them to a CRM, seeing how many conversations a particular teammate has assigned across multiple inboxes, or finding any instance of a particular email address and deleting all associated conversations

improved

[Core API] Draft and conversation sharing

Added support for sharing drafts and adding/removing teammates as followers of a conversation.

added

[Core API] Conversation Reminders

  • Introduced PATCH /conversations/conversation_id/reminders to expose the ability to snooze and unsnooze a conversation. Please see Update conversation reminders ] for more details.

  • Introduced scheduled_reminders to the conversation model. Please see Conversations for more details.

  • Introduced reminder as a possible source for archive and reminder type events. Please see Events for more details. The _meta for this source type will match the model described for scheduled_reminder in Conversations.