provider 244 operations
@utdk/front
Core API
Generated UTDK provider client for Core API. Generated UTDK provider types and OpenAPI-backed client for https://raw.githubusercontent.com/frontapp/front-api-specs/main/core-api/core-api.json.
README
Embedded directly from the package source.
front
Generated UTDK provider types and OpenAPI-backed client for https://raw.githubusercontent.com/frontapp/front-api-specs/main/core-api/core-api.json.
Operations
244 operations —
open try-it console
| Method | Operation ID | Path | Summary | |
|---|---|---|---|---|
| GET | list-accounts | /accounts | List Accounts | Try |
| POST | create-account | /accounts | Create account | Try |
| GET | list-account-custom-fields | /accounts/custom_fields | List Account's custom fields | Try |
| GET | fetch-an-account | /accounts/{account_id} | Fetch an account | Try |
| PATCH | update-account | /accounts/{account_id} | Update account | Try |
| DELETE | delete-an-account | /accounts/{account_id} | Delete an account | Try |
| GET | list-account-contacts | /accounts/{account_id}/contacts | List account contacts | Try |
| POST | add-contact-to-account | /accounts/{account_id}/contacts | Add contact to Account | Try |
| DELETE | remove-contact-from-account | /accounts/{account_id}/contacts | Remove contact from Account | Try |
| POST | create-analytics-export | /analytics/exports | Create a new analytics export | Try |
| GET | get-analytics-export | /analytics/exports/{export_id} | Fetch an analytics export | Try |
| POST | create-analytics-report | /analytics/reports | Create a new analytics report | Try |
| GET | get-analytics-report | /analytics/reports/{report_uid} | Fetch an analytics report | Try |
| POST | trigger-app-event | /applications/{application_uid}/events | Trigger application event | Try |
| GET | list-channels | /channels | List channels | Try |
| GET | get-channel | /channels/{channel_id} | Get channel | Try |
| PATCH | update-channel | /channels/{channel_id} | Update Channel | Try |
| POST | create-draft | /channels/{channel_id}/drafts | Create draft | Try |
| POST | receive-custom-messages | /channels/{channel_id}/incoming_messages | Receive custom messages | Try |
| POST | create-message | /channels/{channel_id}/messages | Create message | Try |
| POST | validate-channel | /channels/{channel_id}/validate | Validate channel | Try |
| GET | get-comment | /comments/{comment_id} | Get comment | Try |
| PATCH | update-comment | /comments/{comment_id}/ | Update comment | Try |
| GET | download-attachment-for-a-comment | /comments/{comment_id}/download/{attachment_link_id} | Download attachment for a comment | Try |
| GET | list-comment-mentions | /comments/{comment_id}/mentions | List comment mentions | Try |
| POST | add-comment-reply | /comments/{comment_id}/replies | Add comment reply | Try |
| GET | list-all-company-rules | /company/rules | List all company rules | Try |
| GET | list-company-ticket-statuses | /company/statuses | List company ticket statuses | Try |
| GET | get-ticket-status-by-id | /company/statuses/{status_id} | Get ticket status | Try |
| GET | list-company-tags | /company/tags | List company tags | Try |
| POST | create-company-tag | /company/tags | Create company tag | Try |
| GET | list-groups | /contact_groups | List groups | Try |
| POST | create-group | /contact_groups | Create group | Try |
| DELETE | delete-group | /contact_groups/{contact_group_id} | Delete group | Try |
| GET | list-contacts-in-group | /contact_groups/{contact_group_id}/contacts | List contacts in group | Try |
| POST | add-contacts-to-group | /contact_groups/{contact_group_id}/contacts | Add contacts to group | Try |
| DELETE | remove-contacts-from-group | /contact_groups/{contact_group_id}/contacts | Remove contacts from group | Try |
| GET | list-contact-lists | /contact_lists | List contact lists | Try |
| POST | create-contact-list | /contact_lists | Create contact list | Try |
| DELETE | delete-contact-list | /contact_lists/{contact_list_id} | Delete contact list | Try |
| GET | list-contacts-in-contact-list | /contact_lists/{contact_list_id}/contacts | List contacts in contact list | Try |
| POST | add-contacts-to-contact-list | /contact_lists/{contact_list_id}/contacts | Add contacts to contact list | Try |
| DELETE | remove-contacts-from-contact-list | /contact_lists/{contact_list_id}/contacts | Remove contacts from contact list | Try |
| GET | list-contacts | /contacts | List contacts | Try |
| POST | create-contact | /contacts | Create contact | Try |
| GET | list-contact-custom-fields | /contacts/custom_fields | List Contact's custom fields | Try |
| POST | merge-contacts | /contacts/merge | Merge contacts | Try |
| GET | get-contact | /contacts/{contact_id} | Get contact | Try |
| PATCH | update-a-contact | /contacts/{contact_id} | Update a contact | Try |
| DELETE | delete-a-contact | /contacts/{contact_id} | Delete a contact | Try |
| GET | list-contact-conversations | /contacts/{contact_id}/conversations | List contact conversations | Try |
| POST | add-contact-handle | /contacts/{contact_id}/handles | Add contact handle | Try |
| DELETE | delete-contact-handle | /contacts/{contact_id}/handles | Delete contact handle | Try |
| GET | list-notes | /contacts/{contact_id}/notes | List notes | Try |
| POST | add-note | /contacts/{contact_id}/notes | Add note | Try |
| GET | list-conversations | /conversations | List conversations | Try |
| POST | create-conversation | /conversations | Create discussion conversation | Try |
| GET | list-conversation-custom-fields | /conversations/custom_fields | List Conversation's custom fields | Try |
| GET | search-conversations | /conversations/search/{query} | Search conversations | Try |
| GET | get-conversation-by-id | /conversations/{conversation_id} | Get conversation | Try |
| PATCH | update-conversation | /conversations/{conversation_id} | Update conversation | Try |
| DELETE | delete-conversation | /conversations/{conversation_id} | Delete conversation | Try |
| PUT | update-conversation-assignee | /conversations/{conversation_id}/assignee | Update conversation assignee | Try |
| GET | list-conversation-comments | /conversations/{conversation_id}/comments | List conversation comments | Try |
| POST | add-comment | /conversations/{conversation_id}/comments | Add comment | Try |
| GET | list-conversation-drafts | /conversations/{conversation_id}/drafts | List conversation drafts | Try |
| POST | create-draft-reply | /conversations/{conversation_id}/drafts | Create draft reply | Try |
| GET | list-conversation-events | /conversations/{conversation_id}/events | List conversation events | Try |
| GET | list-conversation-followers | /conversations/{conversation_id}/followers | List conversation followers | Try |
| POST | add-conversation-followers | /conversations/{conversation_id}/followers | Add conversation followers | Try |
| DELETE | delete-conversation-followers | /conversations/{conversation_id}/followers | Delete conversation followers | Try |
| GET | list-conversation-inboxes | /conversations/{conversation_id}/inboxes | List conversation inboxes | Try |
| POST | add-conversation-link | /conversations/{conversation_id}/links | Add conversation link | Try |
| DELETE | remove-conversation-links | /conversations/{conversation_id}/links | Remove conversation links | Try |
| GET | list-conversation-messages | /conversations/{conversation_id}/messages | List conversation messages | Try |
| POST | create-message-reply | /conversations/{conversation_id}/messages | Create message reply | Try |
| PATCH | update-conversation-reminders | /conversations/{conversation_id}/reminders | Update conversation reminders | Try |
| POST | add-conversation-tag | /conversations/{conversation_id}/tags | Add conversation tag | Try |
| DELETE | remove-conversation-tag | /conversations/{conversation_id}/tags | Remove conversation tag | Try |
| GET | list-custom-fields | /custom_fields | List Contact's custom fields | Try |
| GET | download-attachment | /download/{attachment_link_id} | Download attachment | Try |
| DELETE | delete-draft | /drafts/{draft_id} | Delete draft | Try |
| PATCH | edit-draft | /drafts/{message_id}/ | Edit draft | Try |
| GET | list-events | /events | List events | Try |
| GET | get-event | /events/{event_id} | Get event | Try |
| GET | list-inboxes | /inboxes | List inboxes | Try |
| POST | create-inbox | /inboxes | Create inbox | Try |
| GET | list-inbox-custom-fields | /inboxes/custom_fields | List Inbox's custom fields | Try |
| GET | get-inbox | /inboxes/{inbox_id} | Get inbox | Try |
| GET | list-inbox-channels | /inboxes/{inbox_id}/channels | List inbox channels | Try |
| POST | create-a-channel | /inboxes/{inbox_id}/channels | Create a channel | Try |
| GET | list-inbox-conversations | /inboxes/{inbox_id}/conversations | List inbox conversations | Try |
| POST | import-inbox-message | /inboxes/{inbox_id}/imported_messages | Import message | Try |
| GET | list-inbox-access | /inboxes/{inbox_id}/teammates | List inbox access | Try |
| POST | add-inbox-access | /inboxes/{inbox_id}/teammates | Add inbox access | Try |
| DELETE | removes-inbox-access | /inboxes/{inbox_id}/teammates | Removes inbox access | Try |
| GET | get-a-knowledge-base-article | /knowledge_base_articles/{article_id} | Get a knowledge base article | Try |
| DELETE | delete-an-article | /knowledge_base_articles/{article_id} | Delete an article | Try |
| GET | get-knowledge-base-article-with-content-in-default-locale | /knowledge_base_articles/{article_id}/content | Get knowledge base article with content in default locale | Try |
| PATCH | update-article-content-in-default-locale | /knowledge_base_articles/{article_id}/content | Update article content in default locale. | Try |
| GET | download-attachment-from-an-article | /knowledge_base_articles/{article_id}/download/{attachment_id} | Download attachment from an article | Try |
| GET | get-knowledge-base-article-with-content-in-specified-locale | /knowledge_base_articles/{article_id}/locales/{locale}/content | Get knowledge base article with content in specified locale | Try |
| PATCH | update-article-content-in-specified-locale | /knowledge_base_articles/{article_id}/locales/{locale}/content | Update article content in specified locale | Try |
| GET | get-a-knowledge-base-category | /knowledge_base_categories/{category_id} | Get a knowledge base category | Try |
| DELETE | delete-a-knowledge-base-category | /knowledge_base_categories/{category_id} | Delete a knowledge base category | Try |
| GET | list-articles-in-a-category | /knowledge_base_categories/{category_id}/articles | List articles in a category | Try |
| GET | get-knowledge-base-category-content-in-default-locale | /knowledge_base_categories/{category_id}/content | Get knowledge base category content in default locale | Try |
| PATCH | update-knowledge-base-category-in-default-locale | /knowledge_base_categories/{category_id}/content | Update knowledge base category in default locale | Try |
| GET | get-knowledge-base-category-with-content-in-specified-locale | /knowledge_base_categories/{category_id}/locales/{locale}/content | Get knowledge base category with content in specified locale | Try |
| PATCH | update-knowledge-base-category-in-specified-locale | /knowledge_base_categories/{category_id}/locales/{locale}/content | Update knowledge base category in specified locale | Try |
| GET | list-knowledge-bases | /knowledge_bases | List knowledge bases | Try |
| POST | create-a-knowledge-base | /knowledge_bases | Create a knowledge base | Try |
| GET | get-a-knowledge-base | /knowledge_bases/{knowledge_base_id} | Get a knowledge base | Try |
| GET | list-articles-in-a-knowledge-base | /knowledge_bases/{knowledge_base_id}/articles | List articles in a knowledge base | Try |
| POST | create-article-in-a-knowledge-base-in-default-locale | /knowledge_bases/{knowledge_base_id}/articles | Create article in a knowledge base in default locale | Try |
| GET | list-categories-in-a-knowledge-base | /knowledge_bases/{knowledge_base_id}/categories | List categories in a knowledge base | Try |
| POST | create-knowledge-base-category-in-default-locale | /knowledge_bases/{knowledge_base_id}/categories | Create knowledge base category in default locale | Try |
| GET | get-a-knowledge-base-with-content-in-default-locale | /knowledge_bases/{knowledge_base_id}/content | Get a knowledge base with content in default locale | Try |
| PATCH | update-knowledge-base-in-default-locale | /knowledge_bases/{knowledge_base_id}/content | Update knowledge base in default locale | Try |
| POST | create-article-in-a-knowledge-base-in-specified-locale | /knowledge_bases/{knowledge_base_id}/locales/{locale}/articles | Create article in a knowledge base in specified locale | Try |
| POST | create-knowledge-base-category-in-specified-locale | /knowledge_bases/{knowledge_base_id}/locales/{locale}/categories | Create knowledge base category in specified locale | Try |
| GET | get-a-knowledge-base-with-content-in-specified-locale | /knowledge_bases/{knowledge_base_id}/locales/{locale}/content | Get a knowledge base with content in specified locale | Try |
| PATCH | update-knowledge-base-in-specified-locale | /knowledge_bases/{knowledge_base_id}/locales/{locale}/content | Update knowledge base in specified locale | Try |
| GET | list-links | /links | List links | Try |
| POST | create-link | /links | Create link | Try |
| GET | list-link-custom-fields | /links/custom_fields | List Link's custom fields | Try |
| GET | get-link | /links/{link_id} | Get link | Try |
| PATCH | update-a-link | /links/{link_id} | Update a link | Try |
| GET | list-link-conversations | /links/{link_id}/conversations | List link conversations | Try |
| GET | api-token-details | /me | API Token details | Try |
| GET | list-folders | /message_template_folders | List folders | Try |
| POST | create-folder | /message_template_folders | Create folder | Try |
| GET | get-folder | /message_template_folders/{message_template_folder_id} | Get folder | Try |
| PATCH | update-folder | /message_template_folders/{message_template_folder_id} | Update folder | Try |
| DELETE | delete-folder | /message_template_folders/{message_template_folder_id} | Delete folder | Try |
| GET | get-child-folders | /message_template_folders/{message_template_folder_id}/message_template_folders | Get child folders | Try |
| POST | create-child-folder | /message_template_folders/{message_template_folder_id}/message_template_folders | Create child folder | Try |
| GET | get-child-templates | /message_template_folders/{message_template_folder_id}/message_templates | Get child templates | Try |
| POST | create-child-template | /message_template_folders/{message_template_folder_id}/message_templates | Create child template | Try |
| GET | list-message-templates | /message_templates | List message templates | Try |
| POST | create-message-template | /message_templates | Create message template | Try |
| GET | get-message-template | /message_templates/{message_template_id} | Get message template | Try |
| PATCH | update-message-template | /message_templates/{message_template_id} | Update message template | Try |
| DELETE | delete-message-template | /message_templates/{message_template_id} | Delete message template | Try |
| GET | download-attachment-for-a-message-template | /message_templates/{message_template_id}/download/{attachment_link_id} | Download attachment for a message template | Try |
| GET | get-message | /messages/{message_id} | Get message | Try |
| GET | download-attachment-for-a-message | /messages/{message_id}/download/{attachment_link_id} | Download attachment for a message | Try |
| GET | get-message-seen-status | /messages/{message_id}/seen | Get message seen status | Try |
| POST | mark-message-seen | /messages/{message_id}/seen | Mark message seen | Try |
| GET | list-rules | /rules | List rules | Try |
| GET | get-rule | /rules/{rule_id} | Get rule | Try |
| GET | list-shifts | /shifts | List Shifts | Try |
| POST | create-shift | /shifts | Create shift | Try |
| GET | get-shift | /shifts/{shift_id} | Get shift | Try |
| PATCH | update-shift | /shifts/{shift_id} | Update shift | Try |
| GET | list-shifts-teammates | /shifts/{shift_id}/teammates | List shift's teammates | Try |
| POST | add-teammates-to-shift | /shifts/{shift_id}/teammates | Add teammates to shift | Try |
| DELETE | remove-teammates-from-shift | /shifts/{shift_id}/teammates | Remove teammates from shift | Try |
| GET | get-signatures | /signatures/{signature_id} | Get signatures | Try |
| PATCH | update-signature | /signatures/{signature_id} | Update signature | Try |
| DELETE | delete-signature | /signatures/{signature_id} | Delete signature | Try |
| GET | list-tags | /tags | List tags | Try |
| POST | create-tag | /tags | Create tag | Try |
| GET | get-tag | /tags/{tag_id} | Get tag | Try |
| PATCH | update-a-tag | /tags/{tag_id} | Update a tag | Try |
| DELETE | delete-tag | /tags/{tag_id} | Delete tag | Try |
| GET | list-tag-children | /tags/{tag_id}/children | List tag children | Try |
| POST | create-child-tag | /tags/{tag_id}/children | Create child tag | Try |
| GET | list-tagged-conversations | /tags/{tag_id}/conversations | List tagged conversations | Try |
| GET | list-company-teammate-groups | /teammate_groups | List teammate groups | Try |
| POST | create-company-teammate-group | /teammate_groups | Create teammate group | Try |
| GET | get-company-teammate-group | /teammate_groups/{teammate_group_id} | Get teammate group | Try |
| PATCH | update-a-company-teammate-group | /teammate_groups/{teammate_group_id} | Update a teammate group | Try |
| DELETE | delete-company-teammate-group | /teammate_groups/{teammate_group_id} | Delete teammate group | Try |
| GET | list-company-teammate-group-team-inboxes | /teammate_groups/{teammate_group_id}/inboxes | List teammate group team inboxes | Try |
| POST | add-company-teammate-group-team-inboxes | /teammate_groups/{teammate_group_id}/inboxes | Add teammate group team inboxes | Try |
| DELETE | remove-company-teammate-group-team-inboxes | /teammate_groups/{teammate_group_id}/inboxes | Remove teammate group team inboxes | Try |
| GET | list-company-teammate-group-teammates | /teammate_groups/{teammate_group_id}/teammates | List teammate group teammates | Try |
| POST | add-company-teammate-group-teammates | /teammate_groups/{teammate_group_id}/teammates | Add teammate group teammates | Try |
| DELETE | remove-company-teammate-group-teammates | /teammate_groups/{teammate_group_id}/teammates | Remove teammate group teammates | Try |
| GET | list-company-teammate-group-teams | /teammate_groups/{teammate_group_id}/teams | List teammate group teams | Try |
| POST | add-company-teammate-group-teams | /teammate_groups/{teammate_group_id}/teams | Add teammate group teams | Try |
| DELETE | remove-company-teammate-group-teams | /teammate_groups/{teammate_group_id}/teams | Remove teammate group teams | Try |
| GET | list-teammates | /teammates | List teammates | Try |
| GET | list-teammate-custom-fields | /teammates/custom_fields | List Teammate's custom fields | Try |
| GET | get-teammate | /teammates/{teammate_id} | Get teammate | Try |
| PATCH | update-teammate | /teammates/{teammate_id} | Update teammate | Try |
| GET | list-teammate-channels | /teammates/{teammate_id}/channels | List teammate channels | Try |
| GET | list-teammate-groups | /teammates/{teammate_id}/contact_groups | List teammate groups | Try |
| POST | create-teammate-group | /teammates/{teammate_id}/contact_groups | Create teammate group | Try |
| GET | list-teammate-contact-lists | /teammates/{teammate_id}/contact_lists | List teammate contact lists | Try |
| POST | create-teammate-contact-list | /teammates/{teammate_id}/contact_lists | Create teammate contact list | Try |
| GET | list-teammate-contacts | /teammates/{teammate_id}/contacts | List teammate contacts | Try |
| POST | create-teammate-contact | /teammates/{teammate_id}/contacts | Create teammate contact | Try |
| GET | list-assigned-conversations | /teammates/{teammate_id}/conversations | List assigned conversations | Try |
| GET | list-teammate-inboxes | /teammates/{teammate_id}/inboxes | List teammate inboxes | Try |
| GET | list-teammate-folders | /teammates/{teammate_id}/message_template_folders | List teammate folders | Try |
| POST | create-teammate-folder | /teammates/{teammate_id}/message_template_folders | Create teammate folder | Try |
| GET | list-teammate-message-templates | /teammates/{teammate_id}/message_templates | List teammate message templates | Try |
| POST | create-teammate-message-template | /teammates/{teammate_id}/message_templates | Create teammate message template | Try |
| GET | list-teammate-private-inboxes | /teammates/{teammate_id}/private_inboxes | List teammate private inboxes | Try |
| POST | create-teammate-private-inbox | /teammates/{teammate_id}/private_inboxes | Create teammate private inbox | Try |
| GET | list-teammate-rules | /teammates/{teammate_id}/rules | List teammate rules | Try |
| GET | list-teammate-shifts | /teammates/{teammate_id}/shifts | List Teammate Shifts | Try |
| GET | list-teammate-signatures | /teammates/{teammate_id}/signatures | List teammate signatures | Try |
| POST | create-teammate-signature | /teammates/{teammate_id}/signatures | Create teammate signature | Try |
| GET | list-teammate-tags | /teammates/{teammate_id}/tags | List teammate tags | Try |
| POST | create-teammate-tag | /teammates/{teammate_id}/tags | Create teammate tag | Try |
| GET | list-teammate-time-offs | /teammates/{teammate_id}/time_offs | List teammate time offs | Try |
| POST | create-time-off | /teammates/{teammate_id}/time_offs | Create time off | Try |
| GET | list-teams | /teams | List teams | Try |
| GET | get-team | /teams/{team_id} | Get team | Try |
| GET | list-team-channels | /teams/{team_id}/channels | List team channels | Try |
| GET | list-team-groups | /teams/{team_id}/contact_groups | List team groups | Try |
| POST | create-team-group | /teams/{team_id}/contact_groups | Create team group | Try |
| GET | list-team-contact-lists | /teams/{team_id}/contact_lists | List team contact lists | Try |
| POST | create-team-contact-list | /teams/{team_id}/contact_lists | Create team contact list | Try |
| GET | list-team-contacts | /teams/{team_id}/contacts | List team contacts | Try |
| POST | create-team-contact | /teams/{team_id}/contacts | Create team contact | Try |
| GET | list-team-inboxes | /teams/{team_id}/inboxes | List team inboxes | Try |
| POST | create-team-inbox | /teams/{team_id}/inboxes | Create team inbox | Try |
| GET | list-team-folders | /teams/{team_id}/message_template_folders | List team folders | Try |
| POST | create-team-folder | /teams/{team_id}/message_template_folders | Create team folder | Try |
| GET | list-team-message-templates | /teams/{team_id}/message_templates | List team message templates | Try |
| POST | create-team-message-template | /teams/{team_id}/message_templates | Create team message template | Try |
| GET | list-team-rules | /teams/{team_id}/rules | List team rules | Try |
| GET | list-team-shifts | /teams/{team_id}/shifts | List team Shifts | Try |
| POST | create-team-shift | /teams/{team_id}/shifts | Create team shift | Try |
| GET | list-team-signatures | /teams/{team_id}/signatures | List team signatures | Try |
| POST | create-team-signature | /teams/{team_id}/signatures | Create team signature | Try |
| GET | list-team-tags | /teams/{team_id}/tags | List team tags | Try |
| POST | create-team-tag | /teams/{team_id}/tags | Create team tag | Try |
| POST | add-teammates-to-team | /teams/{team_id}/teammates | Add teammates to team | Try |
| DELETE | remove-teammates-from-team | /teams/{team_id}/teammates | Remove teammates from team | Try |
| GET | list-team-time-offs | /teams/{team_id}/time_offs | List team time offs | Try |
| GET | list-team-views | /teams/{team_id}/views | List team views | Try |
| POST | create-team-view | /teams/{team_id}/views | Create team view | Try |
| GET | get-time-off | /time_offs/{time_off_id} | Get time off | Try |
| PATCH | update-time-off | /time_offs/{time_off_id} | Update time off | Try |
| DELETE | delete-time-off | /time_offs/{time_off_id} | Delete time off | Try |
| GET | list-views | /views | List views | Try |
| GET | get-view | /views/{view_id} | Get view | Try |
| PATCH | update-view | /views/{view_id} | Update view | Try |
| POST | add-view-teammates | /views/{view_id}/teammates | Add view to teammate sidebars | Try |