Jump to Content
Guides
API Reference
Changelog
Community
Guides
API Reference
Changelog
Guides
API Reference
Changelog
Community
Front
API Reference
Front
API Reference
move
All
Pages
Start typing to search…
JUMP TO
Core API
Channels
List channels
get
Get channel
get
Update Channel
patch
Validate channel
post
Create a channel
post
List teammate channels
get
List team channels
get
Accounts
List Accounts
get
Create account
post
Fetch an account
get
Update account
patch
Delete an account
del
List account contacts
get
Add contact to Account
post
Remove contact from Account
del
Analytics
Create a new analytics export
post
Fetch an analytics export
get
Create a new analytics report
post
Fetch an analytics report
get
Messages
Receive custom messages
post
Create message
post
Create message reply
post
Import message
post
Get message
get
Get message seen status
get
Mark message seen
post
Drafts
Create draft
post
List conversation drafts
get
Create draft reply
post
Delete draft
del
Edit draft
patch
Applications
Trigger application event
post
Introduction
Comments
Get comment
get
Update comment
patch
List comment mentions
get
List conversation comments
get
Add comment
post
Add comment reply
post
Attachments
Download attachment for a comment
get
Download attachment
get
Download attachment for a message template
get
Download attachment for a message
get
Response Body Structure
Statuses
List company ticket statuses
get
Get ticket status
get
Rules
List all company rules
get
List rules
get
Get rule
get
List teammate rules
get
List team rules
get
Tags
List company tags
get
Create company tag
post
List tags
get
Create tag
post
Get tag
get
Update a tag
patch
Delete tag
del
List tag children
get
Create child tag
post
List tagged conversations
get
List teammate tags
get
Create teammate tag
post
List team tags
get
Create team tag
post
API Terminology 101
Contacts
List contacts
get
Create contact
post
Merge contacts
post
Get contact
get
Update a contact
patch
Delete a contact
del
List contact conversations
get
List teammate contacts
get
Create teammate contact
post
List team contacts
get
Create team contact
post
Contact Groups
List groups
get
Create group
post
Delete group
del
List contacts in group
get
Add contacts to group
post
Remove contacts from group
del
List teammate groups
get
Create teammate group
post
List team groups
get
Create team group
post
Contact Handles
Add contact handle
post
Delete contact handle
del
Conversations
List conversations
get
Create discussion conversation
post
Search conversations
get
Get conversation
get
Update conversation
patch
Update conversation assignee
put
List conversation events
get
List conversation followers
get
Add conversation followers
post
Delete conversation followers
del
List conversation inboxes
get
Add conversation link
post
Remove conversation links
del
List conversation messages
get
Update conversation reminders
patch
Add conversation tag
post
Remove conversation tag
del
Delete conversation
del
Events
List events
get
Get event
get
Inboxes
List inboxes
get
Create inbox
post
Get inbox
get
List inbox channels
get
List inbox conversations
get
List inbox access
get
Add inbox access
post
Removes inbox access
del
List team inboxes
get
Create team inbox
post
Contact Lists
List contact lists
get
Create contact list
post
Delete contact list
del
List contacts in contact list
get
Add contacts to contact list
post
Remove contacts from contact list
del
List teammate contact lists
get
Create teammate contact list
post
List team contact lists
get
Create team contact list
post
Contact Notes
List notes
get
Add note
post
Custom Fields
List Account's custom fields
get
List Contact's custom fields
get
List Conversation's custom fields
get
List Contact's custom fields
get
List Inbox's custom fields
get
List Link's custom fields
get
List Teammate's custom fields
get
Links
List links
get
Create link
post
Get link
get
Update a link
patch
List link conversations
get
Knowledge Bases
List knowledge bases
get
Create a knowledge base
post
Get a knowledge base
get
Get a knowledge base with content in default locale
get
List categories in a knowledge base
get
Update knowledge base in default locale
patch
List articles in a knowledge base
get
Get a knowledge base with content in specified locale
get
Update knowledge base in specified locale
patch
Knowledge Base Articles
Get a knowledge base article
get
Delete an article
del
Get knowledge base article with content in default locale
get
Update article content in default locale.
patch
Create article in a knowledge base in default locale
post
Download attachment from an article
get
Get knowledge base article with content in specified locale
get
Update article content in specified locale
patch
Create article in a knowledge base in specified locale
post
Knowledge Base Categories
Get a knowledge base category
get
Delete a knowledge base category
del
Get knowledge base category content in default locale
get
Update knowledge base category in default locale
patch
Get knowledge base category with content in specified locale
get
Create knowledge base category in default locale
post
Update knowledge base category in specified locale
patch
List articles in a category
get
Create knowledge base category in specified locale
post
Message Templates
Get child templates
get
Create child template
post
List message templates
get
Create message template
post
Get message template
get
Update message template
patch
Delete message template
del
List teammate message templates
get
Create teammate message template
post
List team message templates
get
Create team message template
post
Message Template Folders
List folders
get
Create folder
post
Get folder
get
Update folder
patch
Delete folder
del
Get child folders
get
Create child folder
post
List teammate folders
get
Create teammate folder
post
List team folders
get
Create team folder
post
Shifts
Get shift
get
List shift's teammates
get
Add teammates to shift
post
Remove teammates from shift
del
List Shifts
get
Create shift
post
Update shift
patch
List Teammate Shifts
get
List team Shifts
get
Create team shift
post
Signatures
Get signatures
get
Update signature
patch
Delete signature
del
List teammate signatures
get
Create teammate signature
post
List team signatures
get
Create team signature
post
Token Identity
API Token details
get
Teammates
List teammates
get
Get teammate
get
Update teammate
patch
List assigned conversations
get
List teammate inboxes
get
Teams / Workspaces
List teams
get
Get team
get
Add teammates to team
post
Remove teammates from team
del
Views
List team views
get
Create team view
post
List views
get
Get view
get
Update view
patch
Add view to teammate sidebars
post
Teammate groups
List teammate groups
get
Create teammate group
post
Get teammate group
get
Update a teammate group
patch
Delete teammate group
del
List teammate group team inboxes
get
Add teammate group team inboxes
post
Remove teammate group team inboxes
del
List teammate group teammates
get
Add teammate group teammates
post
Remove teammate group teammates
del
List teammate group teams
get
Add teammate group teams
post
Remove teammate group teams
del
Plugin SDK
Introduction
Installation
Plugin Terminology 101
Getting events from Front
Front.contextUpdates
Context API
addLink
addTopic
assign
close
closeDraft
createDraft
downloadAttachment
downloadComposerAttachment
fetchDraft
fetchPath
listChannels
listComments
listInboxes
listMessages
listRecipients
listTags
listTeammates
listTicketStatuses
move
openConversationInPopup
openUrl
openUrlInPopup
removeLink
search
setStatus
tag
untag
updateDraft
Utility Functions
buildCancelTokenSource
isCancelError
delegateAnchorClicksToFront
delegateNewWindowsToFront
Data models
Attachment
CancelToken
Channel
Comment
Contact
Context
EntryPoint
Conversation
CustomField
Draft message
Inbox
Link
Message
PaginationToken
Recipient
Tag
Teammate
TicketStatus
Topic
FAQ
Channel API
Introduction
FAQ
API endpoints
Sync inbound message
post
Sync outbound message
post
Update Channel
patch
Update external message status
put
Application Message Templates
Sync application message template
put
Update application message template
patch
move
Ask AI
Move the selected conversations to an inbox.
