# Freshdesk on boxd

> Freshdesk provides customer support software with ticketing, knowledge base, and automation features for efficient helpdesk operations and better customer experiences.

- Page: https://boxd.sh/integrations/freshdesk/
- CLI: `run freshdesk` (178 commands, 34 marked common)
- SDK: `import { freshdesk } from "@boxd/run"`; every parameter and response type is at `@boxd/run/freshdesk`
- Triggers: none
- Connect: `run auth freshdesk` (API key), or https://app.boxd.sh/integrations/detail/freshdesk
- All integrations: https://boxd.sh/integrations/ (Markdown: https://boxd.sh/integrations/index.md)

## From the shell

```sh
run auth freshdesk      # once: prints a link to connect your account
run freshdesk           # list its commands
run freshdesk get-account
```

Parameters are flags (`--flag value`); object and array parameters take a JSON string. Output is YAML, or JSON with `--json`. Calls use your own connection; `--scope <name>` uses a connection shared with your team.

## From a script

```ts
import { every, freshdesk } from "@boxd/run";

every("1 hour", async () => {
  const result = await freshdesk.getAccount();
  console.log(result);
});
```

Run it with `run freshdesk.run.ts`. Freshdesk has no triggers; `every()` polls on a schedule, keeps the script running as a job, and wakes the machine when it is due.

## Commands

Required flags are listed; `run freshdesk <command> --help` lists the optional ones. "common" marks what `run freshdesk` shows without `--all`.

| Command | SDK method | Required flags | Optional | Description |
|---|---|---|---|---|
| `add-note-to-ticket` ·common | `freshdesk.addNoteToTicket()` | `--body` `--ticket-id` | 3 | Add a private or public note to an existing ticket in Freshdesk |
| `add-ticket-user-access` | `freshdesk.addTicketUserAccess()` | `--ticket-id` `--user-ids` | 0 | Add agent access to a specific ticket in Freshdesk |
| `add-watcher` | `freshdesk.addWatcher()` | `--ticket-id` | 0 | Add the authenticated user as a watcher to a Freshdesk ticket |
| `bulk-unwatch-tickets` | `freshdesk.bulkUnwatchTickets()` | `--ids` | 0 | Remove the authenticated user as a watcher from multiple Freshdesk tickets in bulk |
| `bulk-update-tickets` | `freshdesk.bulkUpdateTickets()` | `--ids` `--properties` | 0 | Update multiple tickets simultaneously in bulk |
| `cancel-contact-import` | `freshdesk.cancelContactImport()` | `--import-id` | 0 | Cancel an ongoing contact import operation in Freshdesk |
| `create-admin` | `freshdesk.createAdmin()` | `--name` | 7 | Create a new admin group in Freshdesk |
| `create-admin-group` ·common | `freshdesk.createAdminGroup()` | `--name` `--type` | 4 | Create a new admin-level support agent group in Freshdesk |
| `create-admin-ticket-field` | `freshdesk.createAdminTicketField()` | `--label` `--label-for-customers` `--type` | 7 | Create a new custom ticket field in Freshdesk |
| `create-admin-ticket-field-section` | `freshdesk.createAdminTicketFieldSection()` | `--choice-ids` `--id` `--label` | 0 | Create a new section within a ticket field in Freshdesk |
| `create-agents` ·common | `freshdesk.createAgents()` | `--agents` | 0 | Create multiple agents in Freshdesk in a single bulk operation |
| `create-canned-response` ·common | `freshdesk.createCannedResponse()` | `--content-html` `--title` `--visibility` | 2 | Create a new canned response in Freshdesk |
| `create-canned-response-bulk` | `freshdesk.createCannedResponseBulk()` | `--canned-responses` | 0 | Create multiple canned responses in bulk via asynchronous operation |
| `create-canned-response-folder` | `freshdesk.createCannedResponseFolder()` | `--name` | 0 | Create a new canned response folder in Freshdesk |
| `create-companies` | `freshdesk.createCompanies()` | `--name` | 8 | Create a new company in Freshdesk |
| `create-contact` ·common | `freshdesk.createContact()` | `--custom-fields` `--name` | 16 | Create a new contact in Freshdesk |
| `create-contact-fields` | `freshdesk.createContactFields()` | `--label` `--label-for-customers` `--type` | 10 | Create a new custom contact field in Freshdesk |
| `create-discussion-category` | `freshdesk.createDiscussionCategory()` | `--description` `--name` | 0 | Create a new discussion category in Freshdesk forums |
| `create-discussion-forum-topic` | `freshdesk.createDiscussionForumTopic()` | `--forum-id` `--message` `--title` | 2 | Create a new topic in a Freshdesk discussion forum |
| `create-discussion-topic-comment` | `freshdesk.createDiscussionTopicComment()` | `--body` `--topic-id` | 0 | Create a new comment on a discussion forum topic |
| `create-email` | `freshdesk.createEmail()` | `--group-id` `--mailbox-type` `--name` `--product-id` `--support-email` | 1 | Create a new email mailbox in Freshdesk |
| `create-forum` | `freshdesk.createForum()` | `--category-id` `--name` | 3 | Create a new forum within a category in Freshdesk discussions |
| `create-sla-policies` ·common | `freshdesk.createSlaPolicies()` | `--applicable-to` `--name` `--sla-target` | 2 | Create a new SLA (Service Level Agreement) policy in Freshdesk |
| `create-solution-article` ·common | `freshdesk.createSolutionArticle()` | `--description` `--folder-id` `--title` | 4 | Create a new solution article in a Freshdesk knowledge base folder |
| `create-solution-category` | `freshdesk.createSolutionCategory()` | `--name` | 2 | Create a new solution category in Freshdesk's knowledge base |
| `create-ticket` | `freshdesk.createTicket()` | `--description` `--subject` | 24 | Creates a new ticket in Freshdesk |
| `create-ticket-forms` | `freshdesk.createTicketForms()` | `--title` | 3 | Create a new ticket form in Freshdesk |
| `create-ticket-outbound-email` ·common | `freshdesk.createTicketOutboundEmail()` | `--description` `--email` `--email-config-id` `--priority` `--subject` | 0 | Create a ticket by sending an outbound email to external recipients |
| `create-ticket-time-entry` | `freshdesk.createTicketTimeEntry()` | `--ticket-id` `--time-spent` | 5 | Create a time entry for a specific ticket in Freshdesk |
| `create-translated-solution-category` | `freshdesk.createTranslatedSolutionCategory()` | `--id` `--language-code` `--name` | 1 | Create a translated version of an existing solution category |
| `currently-authenticated-agent` ·common | `freshdesk.currentlyAuthenticatedAgent()` | — | 0 | Retrieve profile information for the currently authenticated agent |
| `delete-admin-group` | `freshdesk.deleteAdminGroup()` | `--id` | 0 | Delete an admin group from Freshdesk |
| `delete-agent` | `freshdesk.deleteAgent()` | `--agent-id` | 0 | Permanently delete an agent from Freshdesk |
| `delete-automation-rule` | `freshdesk.deleteAutomationRule()` | `--automation-type-id` `--rule-id` | 0 | Permanently deletes an automation rule from Freshdesk by its type and rule ID |
| `delete-company` | `freshdesk.deleteCompany()` | `--company-id` | 0 | Permanently disband a company from Freshdesk |
| `delete-company-field` | `freshdesk.deleteCompanyField()` | `--id` | 0 | Permanently delete a custom company field from Freshdesk |
| `delete-contact` | `freshdesk.deleteContact()` | `--contact-id` | 0 | Soft delete a contact from Freshdesk |
| `delete-contact-field` | `freshdesk.deleteContactField()` | `--contact-field-id` | 0 | Permanently delete a custom contact field from Freshdesk |
| `delete-conversation` | `freshdesk.deleteConversation()` | `--conversation-id` | 0 | Permanently delete a conversation from a ticket in Freshdesk |
| `delete-discussion-category` | `freshdesk.deleteDiscussionCategory()` | `--category-id` | 0 | Permanently deletes a forum discussion category from Freshdesk |
| `delete-discussion-comment` | `freshdesk.deleteDiscussionComment()` | `--id` | 0 | Permanently delete a comment from a discussion in Freshdesk |
| `delete-discussion-forum` | `freshdesk.deleteDiscussionForum()` | `--id` | 0 | Permanently delete a discussion forum in Freshdesk |
| `delete-discussion-topic` | `freshdesk.deleteDiscussionTopic()` | `--id` | 0 | Permanently delete a discussion topic in Freshdesk |
| `delete-discussions-forums-follow` | `freshdesk.deleteDiscussionsForumsFollow()` | `--id` `--user-id` | 0 | Unfollow/unmonitor a discussion forum in Freshdesk |
| `delete-discussions-topics-follow` | `freshdesk.deleteDiscussionsTopicsFollow()` | `--id` `--user-id` | 0 | Unfollow/unmonitor a discussion topic in Freshdesk |
| `delete-email-mailboxes` | `freshdesk.deleteEmailMailboxes()` | `--id` | 0 | Permanently delete an email mailbox from Freshdesk |
| `delete-group` | `freshdesk.deleteGroup()` | `--group-id` | 0 | Permanently disband a group from Freshdesk |
| `delete-multiple-tickets` | `freshdesk.deleteMultipleTickets()` | `--ids` | 0 | Asynchronously deletes multiple tickets in bulk |
| `delete-section` | `freshdesk.deleteSection()` | `--section-id` `--ticket-field-id` | 0 | Permanently delete a section from a ticket field in Freshdesk |
| `delete-skill` | `freshdesk.deleteSkill()` | `--id` | 0 | Permanently delete a skill from Freshdesk |
| `delete-solution-article` | `freshdesk.deleteSolutionArticle()` | `--article-id` | 0 | Permanently delete a solution article and its translated versions in Freshdesk |
| `delete-solution-category` | `freshdesk.deleteSolutionCategory()` | `--category-id` | 0 | Permanently delete a solution category from Freshdesk's knowledge base |
| `delete-solution-folder` | `freshdesk.deleteSolutionFolder()` | `--folder-id` | 0 | Permanently delete a solution folder and its translated versions in Freshdesk |
| `delete-ticket` | `freshdesk.deleteTicket()` | `--ticket-id` | 0 | Permanently delete a ticket from Freshdesk |
| `delete-ticket-field` | `freshdesk.deleteTicketField()` | `--ticket-field-id` | 0 | Permanently delete a custom ticket field from Freshdesk |
| `delete-ticket-form` | `freshdesk.deleteTicketForm()` | `--ticket-form-id` | 0 | Permanently delete a ticket form from Freshdesk |
| `delete-ticket-forms` | `freshdesk.deleteTicketForms()` | `--field-id` `--form-id` | 0 | Permanently delete a specific field from a ticket form in Freshdesk |
| `delete-ticket-summary` | `freshdesk.deleteTicketSummary()` | `--ticket-id` | 0 | Delete the AI-generated summary of a ticket in Freshdesk |
| `delete-ticket-user-access` | `freshdesk.deleteTicketUserAccess()` | `--ticket-id` | 0 | Remove all agent access from a specific ticket in Freshdesk |
| `delete-time-entry` | `freshdesk.deleteTimeEntry()` | `--time-entry-id` | 0 | Permanently delete a time entry from Freshdesk |
| `export-contacts` | `freshdesk.exportContacts()` | `--fields` | 0 | Initiate an asynchronous export of contacts from Freshdesk to CSV file |
| `get-account` ·common | `freshdesk.getAccount()` | — | 0 | View Freshdesk account information |
| `get-agent` ·common | `freshdesk.getAgent()` | `--agent-id` | 0 | Retrieve detailed information about a specific agent by ID |
| `get-agent-availability` | `freshdesk.getAgentAvailability()` | `--agent-id` | 0 | Retrieve availability information for a specific agent |
| `get-agents` ·common | `freshdesk.getAgents()` | `--term` | 0 | Search for agents using autocomplete functionality in Freshdesk |
| `get-business-hours` | `freshdesk.getBusinessHours()` | — | 0 | Retrieves all business hours configurations from Freshdesk |
| `get-canned-response-folders` | `freshdesk.getCannedResponseFolders()` | — | 0 | Retrieve all canned response folders from Freshdesk |
| `get-companies` ·common | `freshdesk.getCompanies()` | — | 2 | Retrieve all companies from a Freshdesk account with pagination support |
| `get-company` ·common | `freshdesk.getCompany()` | `--company-id` | 0 | Retrieve detailed information about a specific company by ID |
| `get-company-fields` ·common | `freshdesk.getCompanyFields()` | — | 0 | Retrieve all company fields configured in Freshdesk |
| `get-contact` ·common | `freshdesk.getContact()` | `--contact-id` | 0 | Retrieve detailed information about a specific contact by ID |
| `get-contact-fields` ·common | `freshdesk.getContactFields()` | — | 0 | Retrieve all contact fields configured in Freshdesk |
| `get-contacts` ·common | `freshdesk.getContacts()` | — | 8 | Retrieve all contacts from a Freshdesk account |
| `get-discussion-category` | `freshdesk.getDiscussionCategory()` | `--id` | 0 | View details of a specific forum category in Freshdesk |
| `get-discussion-topic` | `freshdesk.getDiscussionTopic()` | `--id` | 0 | Retrieve detailed information about a specific discussion topic by ID |
| `get-email-mailbox` | `freshdesk.getEmailMailbox()` | `--id` | 0 | Retrieve detailed information about a specific email mailbox by ID |
| `get-folder-responses` | `freshdesk.getFolderResponses()` | `--folder-id` | 0 | Retrieve all canned responses within a specific folder in Freshdesk |
| `get-imported-contacts` | `freshdesk.getImportedContacts()` | — | 1 | Retrieve details of all contact import operations in Freshdesk |
| `get-job` | `freshdesk.getJob()` | `--id` | 0 | View the status of a bulk job operation |
| `get-scenario-automations-json` | `freshdesk.getScenarioAutomationsJson()` | — | 0 | List all scenario-based automations in Freshdesk |
| `get-search` ·common | `freshdesk.getSearch()` | `--query` | 1 | Search and filter tickets in Freshdesk using flexible query syntax |
| `get-ticket-time-entries` | `freshdesk.getTicketTimeEntries()` | `--ticket-id` | 1 | Retrieve all time entries for a specific ticket in Freshdesk |
| `get-ticket-user-access` | `freshdesk.getTicketUserAccess()` | `--ticket-id` | 0 | Retrieve agent access information for a specific ticket in Freshdesk |
| `get-tickets` | `freshdesk.getTickets()` | — | 11 | Retrieves a list of tickets from Freshdesk |
| `get-translated-solution-category` | `freshdesk.getTranslatedSolutionCategory()` | `--id` `--language-code` | 0 | View a translated solution category in Freshdesk |
| `hard-delete-contact` | `freshdesk.hardDeleteContact()` | `--contact-id` | 1 | Permanently delete a contact from Freshdesk |
| `import-contact` | `freshdesk.importContact()` | `--company-name-column-index` `--email-column-index` `--name-column-index` | 5 | Import contacts in bulk from a CSV file to Freshdesk |
| `list-admin-groups` | `freshdesk.listAdminGroups()` | — | 2 | List all admin groups in Freshdesk |
| `list-all-agents-in-group` | `freshdesk.listAllAgentsInGroup()` | `--group-id` | 0 | Retrieve all agents associated with a specific group in Freshdesk |
| `list-all-sections-for-ticket-field` | `freshdesk.listAllSectionsForTicketField()` | `--ticket-field-id` | 0 | Retrieve all dynamic sections for a specific ticket field in Freshdesk |
| `list-all-skills` | `freshdesk.listAllSkills()` | — | 0 | Retrieve all skills configured in Freshdesk account |
| `list-all-ticket-conversations` ·common | `freshdesk.listAllTicketConversations()` | `--ticket-id` | 2 | Retrieve all conversations of a specific ticket in Freshdesk |
| `list-automation-rules` | `freshdesk.listAutomationRules()` | `--automation-type-id` | 0 | List all automation rules for a specific automation type in Freshdesk |
| `list-discussions` | `freshdesk.listDiscussions()` | — | 1 | Retrieve all forum categories (discussions) from Freshdesk |
| `list-discussions-topics` | `freshdesk.listDiscussionsTopics()` | `--forum-id` | 2 | Retrieve all discussion topics within a specified forum in Freshdesk |
| `list-email` | `freshdesk.listEmail()` | — | 8 | Retrieve all email mailbox configurations from Freshdesk account |
| `list-email-configs` | `freshdesk.listEmailConfigs()` | — | 0 | Retrieve all email configurations from a Freshdesk account |
| `list-forums-in-category` | `freshdesk.listForumsInCategory()` | `--category-id` | 2 | Retrieve all forums within a specified category in Freshdesk |
| `list-monitored-topics` | `freshdesk.listMonitoredTopics()` | — | 2 | Retrieve all discussion topics that are monitored/followed by a specific user in Freshdesk |
| `list-participated-topics` | `freshdesk.listParticipatedTopics()` | — | 2 | Retrieve discussion topics that a user has participated in by creating or commenting |
| `list-products` | `freshdesk.listProducts()` | — | 0 | Retrieve all products configured in Freshdesk account |
| `list-roles` | `freshdesk.listRoles()` | — | 2 | Retrieve all roles available in the Freshdesk system with their permissions and details |
| `list-satisfaction-ratings` | `freshdesk.listSatisfactionRatings()` | — | 3 | Retrieve all customer satisfaction survey ratings from Freshdesk |
| `list-sla-policies` | `freshdesk.listSlaPolicies()` | — | 0 | Retrieve all SLA (Service Level Agreement) policies in Freshdesk |
| `list-solution-articles` ·common | `freshdesk.listSolutionArticles()` | `--folder-id` | 1 | Retrieve all solution articles within a specified folder in Freshdesk |
| `list-solution-categories` ·common | `freshdesk.listSolutionCategories()` | — | 1 | Retrieve all solution categories in Freshdesk |
| `list-solution-folders` | `freshdesk.listSolutionFolders()` | `--category-id` | 1 | Retrieve all folders within a specified solution category in Freshdesk |
| `list-solution-subfolders` | `freshdesk.listSolutionSubfolders()` | `--folder-id` | 1 | List all subfolders within a specific solution folder in Freshdesk |
| `list-solutions-category-folders-translated` | `freshdesk.listSolutionsCategoryFoldersTranslated()` | `--category-id` `--language-code` | 1 | Retrieve all translated solution folders in a category |
| `list-specific-section-details` | `freshdesk.listSpecificSectionDetails()` | `--section-id` `--ticket-field-id` | 0 | Retrieve details of a specific section within a ticket field in Freshdesk |
| `list-surveys` | `freshdesk.listSurveys()` | — | 1 | Retrieve all surveys from a Freshdesk account |
| `list-ticket-fields` | `freshdesk.listTicketFields()` | — | 0 | List all ticket fields configured in Freshdesk |
| `list-ticket-forms` | `freshdesk.listTicketForms()` | — | 3 | Retrieve all ticket forms from Freshdesk |
| `list-ticket-satisfaction-ratings` | `freshdesk.listTicketSatisfactionRatings()` | `--ticket-id` | 2 | List all satisfaction ratings of a ticket |
| `list-tickets-watchers` | `freshdesk.listTicketsWatchers()` | `--id` | 0 | List all watchers subscribed to a specific Freshdesk ticket |
| `list-time-entries` | `freshdesk.listTimeEntries()` | — | 7 | Retrieve all time entries from Freshdesk with optional filtering by company, agent, execution time range, and billable status |
| `list-topic-comments2` | `freshdesk.listTopicComments2()` | `--id` | 2 | List all comments on a specific discussion topic with pagination support |
| `list-translated-solution-articles` | `freshdesk.listTranslatedSolutionArticles()` | `--id` `--language-code` | 1 | View all translated solution articles in a folder for a specific language |
| `list-translated-subfolders` | `freshdesk.listTranslatedSubfolders()` | `--folder-id` `--language-code` | 1 | List all translated subfolders within a parent folder in Freshdesk |
| `patch-admin-groups-agents` ·common | `freshdesk.patchAdminGroupsAgents()` | `--agents` `--id` | 0 | Add or remove agents in a Freshdesk group |
| `remove-watcher` | `freshdesk.removeWatcher()` | `--ticket-id` | 0 | Remove the authenticated user as a watcher from a Freshdesk ticket |
| `reply-to-forward-ticket` ·common | `freshdesk.replyToForwardTicket()` | `--body` `--ticket-id` `--to-emails` | 3 | Reply to or forward a ticket to external email addresses |
| `reply-to-ticket` | `freshdesk.replyToTicket()` | `--body` `--ticket-id` | 5 | Create a public reply to an existing support ticket in Freshdesk |
| `search-agents` ·common | `freshdesk.searchAgents()` | — | 6 | Search and filter agents in Freshdesk |
| `search-companies` | `freshdesk.searchCompanies()` | `--query` | 1 | Search and filter companies in Freshdesk using query strings with custom fields |
| `search-company` ·common | `freshdesk.searchCompany()` | `--name` | 0 | Search for companies using autocomplete functionality in Freshdesk |
| `search-contacts` ·common | `freshdesk.searchContacts()` | `--query` | 1 | Search and filter contacts in Freshdesk using query-based search |
| `search-contacts-autocomplete` ·common | `freshdesk.searchContactsAutocomplete()` | `--term` | 0 | Search for contacts using autocomplete functionality in Freshdesk |
| `search-solution-articles` ·common | `freshdesk.searchSolutionArticles()` | `--term` | 1 | Search solution articles in Freshdesk knowledge base by keyword |
| `toggle-timer` | `freshdesk.toggleTimer()` | `--time-entry-id` | 0 | Toggle the timer on a time entry to start or stop time tracking |
| `update-admin-group` ·common | `freshdesk.updateAdminGroup()` | `--id` | 6 | Update an existing admin-level support agent group in Freshdesk |
| `update-admin-ticket-field` | `freshdesk.updateAdminTicketField()` | `--id` | 8 | Update an existing ticket field configuration in Freshdesk |
| `update-admin-ticket-field-section` | `freshdesk.updateAdminTicketFieldSection()` | `--id` `--section-id` | 3 | Update a section within a ticket field in Freshdesk |
| `update-agent` ·common | `freshdesk.updateAgent()` | `--id` | 11 | Update an existing agent's information in Freshdesk |
| `update-agent-availability` | `freshdesk.updateAgentAvailability()` | `--agent-id` `--channel-availability` | 0 | Update agent availability settings in Freshdesk |
| `update-automations` | `freshdesk.updateAutomations()` | `--automation-type-id` `--id` | 6 | Update an existing automation rule in Freshdesk |
| `update-canned-response` | `freshdesk.updateCannedResponse()` | `--id` | 5 | Update an existing canned response in Freshdesk |
| `update-canned-response-folder` | `freshdesk.updateCannedResponseFolder()` | `--folder-id` `--name` | 0 | Updates the name of an existing canned response folder in Freshdesk |
| `update-companies` ·common | `freshdesk.updateCompanies()` | `--company-id` | 9 | Update an existing company's information in Freshdesk |
| `update-contact` ·common | `freshdesk.updateContact()` | `--id` | 16 | Update an existing contact's information in Freshdesk |
| `update-contact-field` | `freshdesk.updateContactField()` | `--contact-field-id` | 6 | Update a contact field's configuration in Freshdesk |
| `update-contact-make-agent` | `freshdesk.updateContactMakeAgent()` | `--id` `--role-ids` `--ticket-scope` | 1 | Convert a contact into an agent in Freshdesk |
| `update-conversations` | `freshdesk.updateConversations()` | `--body` `--id` | 0 | Update the content of a conversation note in Freshdesk |
| `update-discussion-category` | `freshdesk.updateDiscussionCategory()` | `--id` | 2 | Update an existing discussion category in Freshdesk forums |
| `update-discussion-comment` | `freshdesk.updateDiscussionComment()` | `--body` `--id` | 0 | Update an existing comment in a discussion forum |
| `update-discussion-forum` | `freshdesk.updateDiscussionForum()` | `--id` | 6 | Update an existing discussion forum in Freshdesk |
| `update-discussion-topic` | `freshdesk.updateDiscussionTopic()` | `--id` | 6 | Update an existing discussion topic in Freshdesk |
| `update-email-settings` | `freshdesk.updateEmailSettings()` | — | 12 | Update mailbox settings for email handling in Freshdesk |
| `update-notification-email-bcc` | `freshdesk.updateNotificationEmailBcc()` | `--emails` | 0 | Update automatic BCC email addresses for all ticket communications in Freshdesk |
| `update-sla-policies` ·common | `freshdesk.updateSlaPolicies()` | `--id` | 5 | Update an existing SLA (Service Level Agreement) policy in Freshdesk |
| `update-solution-category` | `freshdesk.updateSolutionCategory()` | `--category-id` | 2 | Update an existing solution category in Freshdesk |
| `update-solution-folder` | `freshdesk.updateSolutionFolder()` | `--folder-id` | 8 | Update an existing solution folder in Freshdesk knowledge base |
| `update-solutions` | `freshdesk.updateSolutions()` | `--id` | 7 | Update an existing solution article in Freshdesk |
| `update-ticket` | `freshdesk.updateTicket()` | `--ticket-id` | 27 | Update an existing ticket in Freshdesk |
| `update-ticket-bulk-watch` | `freshdesk.updateTicketBulkWatch()` | `--ids` | 0 | Add the authenticated user as a watcher to multiple tickets in a single bulk operation |
| `update-ticket-forms` | `freshdesk.updateTicketForms()` | `--ticket-form-id` | 4 | Update an existing ticket form in Freshdesk |
| `update-ticket-summary` | `freshdesk.updateTicketSummary()` | `--body` `--ticket-id` | 0 | Update the AI-generated summary of a ticket in Freshdesk |
| `update-ticket-user-access` | `freshdesk.updateTicketUserAccess()` | `--id` `--user-ids` | 0 | Update agent access to a specific ticket in Freshdesk by adding or removing agents |
| `update-time-entry` | `freshdesk.updateTimeEntry()` | `--id` | 7 | Update an existing time entry in Freshdesk |
| `view-automations` | `freshdesk.viewAutomations()` | `--automation-type-id` `--id` | 0 | View details of a specific automation rule in Freshdesk |
| `view-business-hour` | `freshdesk.viewBusinessHour()` | `--business-hours-id` | 0 | Retrieve a specific business hour configuration from Freshdesk |
| `view-canned-response` | `freshdesk.viewCannedResponse()` | `--canned-response-id` | 0 | View details of a specific canned response in Freshdesk |
| `view-company-field` | `freshdesk.viewCompanyField()` | `--company-field-id` | 0 | Retrieve details of a specific company field by ID |
| `view-contact-field` | `freshdesk.viewContactField()` | `--contact-field-id` | 0 | Retrieve details of a specific contact field by ID |
| `view-email` | `freshdesk.viewEmail()` | — | 0 | Retrieve mailbox settings for the Freshdesk account |
| `view-email-configs` | `freshdesk.viewEmailConfigs()` | `--id` | 0 | View details of a specific email configuration in Freshdesk |
| `view-group` | `freshdesk.viewGroup()` | `--group-id` | 0 | View details of a specific admin group in Freshdesk |
| `view-notifications` | `freshdesk.viewNotifications()` | — | 0 | View automatic BCC email addresses configured in Freshdesk |
| `view-products` | `freshdesk.viewProducts()` | `--id` | 0 | Retrieve detailed information about a specific product by ID |
| `view-roles` | `freshdesk.viewRoles()` | `--id` | 0 | View detailed information about a specific role by ID |
| `view-settings` | `freshdesk.viewSettings()` | — | 0 | Retrieve helpdesk settings from Freshdesk |
| `view-skill` | `freshdesk.viewSkill()` | `--id` | 0 | Retrieve a specific skill from Freshdesk by ID |
| `view-solution-category` | `freshdesk.viewSolutionCategory()` | `--category-id` | 0 | View a specific solution category by ID in Freshdesk |
| `view-solution-folder` | `freshdesk.viewSolutionFolder()` | `--folder-id` | 1 | View a specific solution folder by ID in Freshdesk |
| `view-solutions` | `freshdesk.viewSolutions()` | `--article-id` | 1 | View a specific solution article by ID in Freshdesk |
| `view-ticket` | `freshdesk.viewTicket()` | `--ticket-id` | 1 | Views an existing ticket in Freshdesk |
| `view-ticket-field` | `freshdesk.viewTicketField()` | `--ticket-field-id` | 0 | Retrieve a single ticket field configuration from Freshdesk |
| `view-ticket-form-field` | `freshdesk.viewTicketFormField()` | `--field-id` `--form-id` | 0 | Retrieve a specific field from a ticket form in Freshdesk |

## Docs

- [run CLI](https://docs.boxd.sh/cli/run): Call connected integrations from the shell, connect new ones, and run automations.
- [Quickstart](https://docs.boxd.sh/guides/integrations/quickstart): Connect an integration, call it from the shell, and turn a script into an automation.
- [Connections](https://docs.boxd.sh/guides/integrations/connections): Connect an account once, for yourself or for your whole organization.
- [Scripts](https://docs.boxd.sh/guides/automations/scripts): Typed integrations, triggers, schedules and state in a .run.ts file.
- [Jobs](https://docs.boxd.sh/guides/automations/jobs): How a script becomes a background job: states, retries, sleep and wake.
- [Beyond the catalog](https://docs.boxd.sh/guides/automations/beyond-the-catalog): Reach your own APIs, databases and cloud accounts from a script.