Skip to main content
Freshdesk logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 178
  • Triggers: 0
  • Slug: FRESHDESK
  • Version: 20261101_00

Tools

Slug: FRESHDESK_ADD_NOTE_TO_TICKETTool to add a private or public note to an existing ticket in Freshdesk. Use when you need to add internal comments or public notes to a ticket. Notes can be private (agent-only) or public, and can include HTML content.

Input Parameters

string
required
The content of the note. Can contain plain text or HTML.
boolean
Indicates whether the note is private (visible only to agents). Default: true
integer
The ID of the user creating the note (useful for posting on behalf of another user).
integer
required
The unique identifier of the ticket to add the note to.
array
Email addresses to notify about the note. IMPORTANT: Only accepts agent email addresses, not external contacts or non-agent users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_ADD_TICKET_USER_ACCESSAdd agent access to a specific Freshdesk ticket using agent IDs. The result may include IDs returned by the API or the submitted IDs.

Input Parameters

array
required
List of agent IDs to grant access to the ticket. These should be agent IDs, not contact IDs.
integer
required
The unique identifier of the ticket to add user access to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_ADD_WATCHERTool to add the authenticated user as a watcher to a Freshdesk ticket. Use when you need to follow a ticket’s progress and receive email notifications for updates like replies or status changes. The API automatically uses the authenticated user’s credentials and does not require additional parameters.

Input Parameters

integer
required
The unique identifier of the ticket to add the watcher to. The authenticated user will be added as a watcher to this ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_BULK_UNWATCH_TICKETSRemove the authenticated user as a watcher from multiple Freshdesk tickets. The result can report partial success, so check individual succeeded and failed tickets when provided.

Input Parameters

array
required
Array of ticket IDs to remove the authenticated user as a watcher from. The currently authenticated user will be removed as a watcher from all specified tickets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_BULK_UPDATE_TICKETSTool to update multiple tickets simultaneously in bulk. The bulk update operation runs asynchronously in the background, and returns a job_id to track progress. Use when you need to modify the same properties across multiple tickets efficiently.

Input Parameters

array
required
Array of ticket IDs to update in bulk. Example: [18, 17, 123]
object
required
Object containing the fields to update and their new values. At least one property must be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CANCEL_CONTACT_IMPORTTool to cancel an ongoing contact import operation in Freshdesk. Use when you need to halt a contact import process that is currently running.

Input Parameters

integer
required
The unique identifier of the contact import operation to cancel. This ID is obtained from the Get Imported Contacts endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_ADMINTool to create a new admin group in Freshdesk. Use when you need to create a new admin group with specific agents, escalation settings, and automatic assignment configuration.

Input Parameters

string
required
Name of the admin group to create. Must be unique within your Freshdesk account.
array
List of agent IDs to be added to this group
string
Description of the admin group
integer
User ID to escalate unassigned tickets to
string
Time duration before escalation triggers. Must be one of: ‘30m’, ‘1h’, ‘2h’, ‘4h’, ‘8h’, ‘12h’, ‘1d’, ‘2d’, ‘3d’
integer
ID of the business hours configuration to associate with this group
integer
Enables automatic ticket assignment. Set to 0 to disable or 1 to enable.
boolean
Permission flag for agents to change their availability

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_ADMIN_GROUPTool to create a new admin-level support agent group in Freshdesk. Use when you need to create groups for organizing support agents and managing ticket routing at the admin level.

Input Parameters

string
required
The name of the group. Must be unique within the Freshdesk account.
string
required
The type of group. Must be ‘support_agent_group’ for creating support agent groups.
array
Array of agent IDs who should be members of this group.
string
A brief description of the group’s purpose and responsibilities.
integer
ID of the group to which unassigned tickets should be escalated after the specified time period.
string
Time period after which an unassigned ticket in the group should be escalated. Format examples: ‘30m’, ‘1h’, ‘2h’, ‘8h’, ‘1d’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_ADMIN_TICKET_FIELDTool to create a new custom ticket field in Freshdesk. Use when you need to add a new field definition for capturing additional ticket information (e.g., priority level, customer type, issue category). The field type can be text, number, dropdown, checkbox, date, or paragraph.

Input Parameters

string ("custom_text" | "custom_paragraph" | "custom_number" | "custom_dropdown" | "custom_checkbox" | "custom_date" | "custom_decimal" | "custom_phone_number" | "custom_url")
required
The field type. When using ‘custom_dropdown’, you must also provide the ‘choices’ parameter.
string
required
The internal label for the ticket field. This is what agents see in the UI.
array
For dropdown fields, a list of choice objects with ‘value’ and ‘position’ keys. Required when field type is ‘custom_dropdown’. Example: [{‘value’: ‘Low’, ‘position’: 1}, {‘value’: ‘Medium’, ‘position’: 2}]
integer
Position of the field in the form. Lower numbers appear first. If not specified, the field is added at the end.
boolean
Whether customers can edit this field after ticket creation. Defaults to False.
string
required
The customer-facing label for the ticket field. This is displayed to customers in the portal.
boolean
Whether the field is required for agents when creating or updating tickets. Defaults to False.
boolean
Whether the field is required for ticket closure. Defaults to False.
boolean
Whether the field is displayed to customers in the support portal. Defaults to True.
boolean
Whether the field is required for customers when submitting tickets. Defaults to False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_ADMIN_TICKET_FIELD_SECTIONTool to create a new section within a ticket field in Freshdesk. Use when you need to add conditional field sections that appear based on selected dropdown choices.

Input Parameters

integer
required
The unique identifier of the parent ticket field to create a section for
string
required
The display name of the section
array
required
Array of choice IDs for which the section should be displayed. These are the dropdown options that trigger the section to appear

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_AGENTSTool to create multiple agents in Freshdesk in a single bulk operation. Use when you need to add multiple agents at once. This is an asynchronous operation that returns a job_id for tracking the creation status.

Input Parameters

array
required
List of agent objects to create in bulk. Each agent must have at least an email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_AUTOMATION_RULECreate an inactive-by-default Freshdesk automation rule.

Input Parameters

string
required
Name of the automation rule.
boolean
Whether the rule is active. Defaults to false so newly created rules are inactive.
array
Field-change triggers, applicable to ticket-update rules.
array
required
Actions performed when the rule conditions match.
string
Logical expression combining condition sets.
integer
Ordering position of the rule.
object
Performer definition, applicable to ticket-update rules.
array
required
Condition sets that select tickets for this rule.
string
Description of the automation rule.
integer ("1" | "3" | "4")
required
Automation family: 1 for ticket creation, 3 for hourly triggers, or 4 for ticket updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_CANNED_RESPONSETool to create a new canned response in Freshdesk. Use when you need to create a reusable message template that agents can quickly insert into tickets.

Input Parameters

string
required
The title/name of the canned response
integer
ID of the folder to place the canned response in. If not provided, the canned response will be auto-assigned to a folder
array
Array of group IDs that can access this canned response. Only applicable when visibility is set to 2 (specific groups)
integer
required
Visibility of the canned response. 0 = Personal/Private (visible only to creator), 1 = All agents (visible to all agents in the account), 2 = Specific groups (visible to designated agent groups)
string
required
The HTML content of the canned response. This is the message template that will be inserted when the canned response is used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_CANNED_RESPONSE_BULKTool to create multiple canned responses in bulk via asynchronous operation. Use when you need to add multiple canned responses at once to your Freshdesk account. Returns a job_id that can be used to track the operation status.

Input Parameters

array
required
Array of canned response objects to create in bulk. Each object must contain at minimum a title and content or content_html field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_CANNED_RESPONSE_FOLDERTool to create a new canned response folder in Freshdesk. Use when you need to organize canned response templates into folders.

Input Parameters

string
required
The name of the canned response folder to create. This folder will organize canned response templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_COMPANIESTool to create a new company in Freshdesk. Use when you need to add a customer organization to your Freshdesk account. Companies can hold multiple contacts and are automatically associated with contacts based on email domain matching.

Input Parameters

string
required
The name of the company [REQUIRED]
string
Additional notes about the company
array
Array of domain names associated with the company. Freshdesk automatically associates contacts to this company if their email address contains any specified domains
string
Industry classification from standard industry choices (available in Blossom Plan and above)
string
Description about the company
string
Account tier dropdown with three choices: ‘Basic’, ‘Premium’, ‘Enterprise’
string
Health score dropdown with three choices: ‘Happy’, ‘Doing okay’, ‘At risk’
string
Contract or renewal date for the company in YYYY-MM-DD format (available in Blossom Plan and above)
object
Key-value pairs for custom fields specific to your Freshdesk account. Unlike ticket custom fields, company custom field names don’t have ‘cf_’ prepended

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_CONTACTTool to create a new contact in Freshdesk. Use when you need to add a customer or user to your Freshdesk account. IMPORTANT: The ‘employee_id’ custom field is mandatory for this Freshdesk instance.

Input Parameters

string
required
Name of the contact [REQUIRED]
array
Tags associated with the contact
string
Primary email address of the contact. Either email or phone must be provided.
string
Phone number of the contact. Either email or phone must be provided.
string
URL of the contact’s avatar image
string
Mobile number of the contact
string
Physical address of the contact
string
Language code for the contact’s preferred language
string
Job title of the contact
string
Time zone of the contact
integer
ID of the primary company associated with this contact
string
Twitter handle of the contact
string
Description or notes about the contact
array
Additional email addresses of the contact
object
required
Custom fields object. IMPORTANT: The ‘employee_id’ field is required for this Freshdesk instance and cannot be blank. Custom field keys should be the field name directly (not prefixed with ‘cf_’).
array
Array of other company IDs associated with the contact. Each item should have ‘company_id’ and optionally ‘view_all_tickets’
boolean
Set to true if the contact can view all tickets from their company
string
External ID of the contact for integration purposes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_CONTACT_FIELDSTool to create a new custom contact field in Freshdesk. Use when you need to add a new field definition for storing custom contact information (e.g., job title, department, customer type). The field type can be text, number, dropdown, checkbox, date, or paragraph.

Input Parameters

string
required
Type of the contact field. Valid types are: ‘custom_text’ (single line text), ‘custom_paragraph’ (multi-line text), ‘custom_number’ (numeric), ‘custom_dropdown’ (dropdown select), ‘custom_checkbox’ (boolean), ‘custom_date’ (date picker), ‘custom_phone_number’ (phone number), ‘custom_url’ (URL), ‘lookup’ (lookup field), ‘encrypted_text’ (encrypted text). When using ‘custom_dropdown’, you must also provide the ‘choices’ parameter.
string
required
Display label for the contact field. This is what users will see in the UI.
array
List of choice options for dropdown fields. Required when field type is ‘custom_dropdown’. Each choice should have a label (display text) and value (actual value stored).
integer
Position/order of the field in the UI. Lower numbers appear first. Must be between 1 and 46 inclusive.
boolean
Whether agents can edit this field value. Required when ‘required_for_agents’ is True. Defaults to True if not specified.
boolean
Whether customers can edit this field value in the portal. Defaults to False.
boolean
Whether this field can be edited during customer signup. Defaults to False.
string
required
Label to display to customers in the portal. This field is required by the Freshdesk API.
boolean
Whether this field appears in the quick-add form for agents (for frequently used fields). Required when ‘required_for_agents’ is True. Defaults to True if not specified.
boolean
Whether this field is required for agents when creating or updating contacts. Defaults to False.
boolean
Whether this field is displayed to agents. Required when ‘required_for_agents’ is True. Defaults to True if not specified.
boolean
Whether this field is required for customers in the portal. Defaults to False.
boolean
Whether this field is displayed to customers in the portal. Defaults to False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_DISCUSSION_CATEGORYTool to create a new discussion category in Freshdesk forums.

Input Parameters

string
required
The name of the discussion category. Must be unique among existing categories.
string
required
A brief description explaining the purpose of this discussion category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_DISCUSSION_FORUM_TOPICTool to create a new topic in a Freshdesk discussion forum. Use when you need to post a new discussion topic or thread in a specific forum.

Input Parameters

string
required
The title of the topic
boolean
Whether the topic should be locked (no replies allowed)
boolean
Whether the topic should be pinned to the top of the forum
string
required
The message/content of the topic. Supports HTML formatting.
integer
required
The ID of the forum in which to create the topic

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_DISCUSSION_TOPIC_COMMENTTool to create a new comment on a discussion forum topic. Use when you need to add a comment to an existing topic in Freshdesk discussions.

Input Parameters

string
required
The content of the comment. Can contain HTML formatting.
integer
required
The unique identifier of the discussion topic to add a comment to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_EMAILTool to create a new email mailbox in Freshdesk. Use when you need to add a support email address that automatically creates tickets from incoming emails. Requires valid product_id and group_id.

Input Parameters

string
required
Display name for the email mailbox
integer
required
ID of the group to assign tickets from this mailbox
integer
required
ID of the product to associate with this mailbox
string ("freshdesk_mailbox" | "custom_mailbox")
required
Type of mailbox. Use ‘freshdesk_mailbox’ for Freshdesk-managed mailboxes or ‘custom_mailbox’ for external email providers
string
required
Email address for the mailbox. Must use your Freshdesk domain (e.g., name@yourdomain.freshdesk.com)
boolean
Set as default reply email address for the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_FORUMTool to create a new forum within a category in Freshdesk discussions. Use when you need to add a new forum to organize discussions within a specific category.

Input Parameters

string
required
The name of the forum. Must be a non-empty string.
integer
The type of forum. Valid values: 1=Questions, 2=Ideas, 3=Problems, 4=Announcements. If not specified, defaults to Questions (1).
integer
required
The ID of the category where the forum will be created. This is a required path parameter.
string
The description of the forum. Supports plain text or HTML content.
integer
The visibility setting for the forum. Valid values: 1=Everyone, 2=Logged in users, 3=Agents only, 4=Selected companies. If not specified, defaults to Everyone (1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_SLA_POLICIESTool to create a new SLA (Service Level Agreement) policy in Freshdesk. Use when you need to establish service level targets for ticket response and resolution times based on priority levels.

Input Parameters

string
required
Name of the SLA policy
boolean
Whether the SLA policy is active or not
object
required
SLA targets for all four priority levels with respond_within and resolve_within times in seconds
string
Description of the SLA policy
object
required
Conditions defining where the SLA policy applies. At least one non-empty array (sources, group_ids, or product_ids) is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_SOLUTION_ARTICLETool to create a new solution article in a Freshdesk knowledge base folder. Use when you need to add documentation, FAQs, or help content to your knowledge base.

Input Parameters

array
Tags for categorizing the article
string
required
Title of the solution article
string ("draft" | "published")
Publication status of the article.
integer
ID of the agent creating the article. If not specified, the authenticated agent will be used
object
SEO data for creating/updating an article (request format).
integer
required
The unique identifier of the folder where the article will be created
string
required
Description/content of the article in HTML format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_SOLUTION_CATEGORYTool to create a new solution category in Freshdesk’s knowledge base. Use when you need to organize solution articles and folders under a new category.

Input Parameters

string
required
The name of the solution category
string
A description of the category and its purpose
array
An array of portal IDs where the category should be visible. If not specified, the category will be visible in all portals by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_TICKETCreate a Freshdesk ticket with a subject, description, and requester identifier; a name is required if phone is provided without email. Supplied attachments are not uploaded.

Input Parameters

string
Name of the requester
array
Tags that have been associated with the ticket
string
Email address of the requester
string
Phone number of the requester
string
Timestamp when the ticket is due to be resolved. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
string ("email" | "portal" | "phone" | "chat" | "feedback_widget" | "outbound_email")
Channel through which the ticket was created.
string ("open" | "pending" | "resolved" | "closed")
Status of the ticket.
string
required
Subject of the ticket. Must be a non-empty string.
integer
ID of the group to which the ticket has been assigned
string ("low" | "medium" | "high" | "urgent")
Priority of the ticket.
array
Email addresses added in the ‘cc’ field of the incoming ticket email
string
Timestamp when the first response is due. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
integer
Company ID of the requester
integer
ID of the product linked to the ticket
string
Twitter handle of the requester
array
Ticket attachments. Note: File attachments require multipart/form-data format and are not supported via JSON API calls.
string
required
HTML content of the ticket. Supports HTML formatting such as <p>, <strong>, <em>, etc.
string
Facebook ID of the requester
integer
User ID of the requester
integer
ID of the agent to whom the ticket has been assigned
object
Key–value pairs containing the names and values of custom fields. Example: {“cf_<field-name>”: “test-value”}. Note: custom fields are to be predefined in Freshdesk.
integer
ID of email config which is used for this ticket
string
Lookup field for custom objects
integer
ID of the internal agent which the ticket should be assigned with
integer
ID of the internal group to which the ticket should be assigned with
string
External ID of the requester

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_TICKET_FORMSTool to create a new ticket form in Freshdesk. Use when you need to create a custom ticket form for organizing support requests.

Input Parameters

string
required
The title of the ticket form (display name shown to users)
array
Array of field configurations for the form
array
Array of portal IDs where the form should be available
string
Description of the ticket form’s purpose

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_TICKET_OUTBOUND_EMAILTool to create a ticket by sending an outbound email to external recipients. Use when you need to initiate a support conversation via email. The ticket is automatically created with ‘Closed’ status and assigned to the sending agent to avoid unnecessary SLA timers.

Input Parameters

string
required
Recipient email address for the outbound email
string
required
Subject line of the outbound email
string ("low" | "medium" | "high" | "urgent")
required
Priority level for the ticket created from this outbound email.
string
required
Body content of the outbound email. Supports HTML formatting
integer
required
Email configuration ID to use for sending the outbound email. Can be obtained from GET /api/v2/email_configs endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_TICKET_TIME_ENTRYTool to create a time entry for a specific ticket in Freshdesk. Use when you need to log time spent working on a ticket. Time entries track work duration and can be marked as billable or non-billable for billing and reporting purposes.

Input Parameters

string
Description or comment about the work done during this time entry.
integer
ID of the agent logging the time entry. If not provided, defaults to the authenticated agent.
boolean
Whether the time entry is billable. Set to true for billable time, false for non-billable time.
integer
required
The unique identifier of the ticket to create a time entry for.
string
Timestamp when the timer was started in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) in UTC.
string
required
Time spent in HH:MM format (e.g., ‘01:30’ for 1 hour 30 minutes, ‘00:15’ for 15 minutes). This is a required field.
string
Timestamp when the work was executed in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) in UTC. If not provided, defaults to current time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CREATE_TRANSLATED_SOLUTION_CATEGORYTool to create a translated version of an existing solution category. Use when you need to add multilingual support to your knowledge base by creating category translations in different languages.

Input Parameters

integer
required
The ID of the solution category (must be an existing category created in the primary language)
string
required
The translated name of the solution category
string
The translated description of the solution category
string
required
The language code for the translation (e.g., ‘fr’ for French, ‘es’ for Spanish, ‘de’ for German)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_CURRENTLY_AUTHENTICATED_AGENTTool to retrieve profile information for the currently authenticated agent. Use when you need to get details about the agent whose API credentials are being used for authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_ADMIN_GROUPTool to delete an admin group from Freshdesk. Use when you need to disband an admin group from your Freshdesk account. Note: Deleting a group only disbands it and does not delete the members of the group.

Input Parameters

integer
required
The unique identifier of the admin group to delete. Deleting a group disbands it but does not delete the group members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_AGENTTool to permanently delete an agent from Freshdesk. Use when you need to remove an agent from your Freshdesk account. Note: You cannot delete yourself. The API prevents self-deletion as a security measure. When an agent is deleted, they are downgraded to a contact in the Freshdesk system.

Input Parameters

integer
required
The unique identifier of the agent to delete. Note: You cannot delete yourself using the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_AUTOMATION_RULEPermanently deletes an automation rule from Freshdesk by its type and rule ID. Use this action to remove workflow automation rules that are no longer needed. This action is idempotent - deleting an already-deleted rule will succeed without error. WARNING: This action is irreversible. The automation rule will be permanently deleted and cannot be recovered. Ensure you have the correct rule_id before proceeding.

Input Parameters

integer
required
The unique identifier of the automation rule to delete. Obtain this ID from the ‘View Automation Rule’ or list automations endpoint.
integer
required
The type of automation rule to delete. Valid values: 1 (ticket creation rules - triggered when new tickets are created), 3 (time-triggered rules - run on a schedule), 4 (ticket update rules - triggered when tickets are updated). Note: Type 2 is not allowed by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_COMPANYDelete a company from Freshdesk without deleting its associated customers. A not-found response is treated as success, so success does not establish that a company was deleted by this call.

Input Parameters

integer
required
The unique identifier of the company to delete. Note: Deleting a company disbands it but does not delete the customers inside it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_COMPANY_FIELDTool to permanently delete a custom company field from Freshdesk. Use when you need to remove a company field that is no longer needed. Note: This action is irreversible and will delete all data stored in that field across all companies. Only custom fields can be deleted, not default fields.

Input Parameters

integer
required
The unique identifier of the company field to delete. Note: Only custom company fields can be deleted, not default fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_CONTACTTool to soft delete a contact from Freshdesk. Use when you need to move a contact from All Contacts to Deleted Contacts view. Future communications from the contact will be directed to SPAM. The contact can be restored later - for permanent deletion, use hard_delete_contact instead.

Input Parameters

integer
required
The unique identifier of the contact to be soft deleted. This is the contact’s numeric ID in Freshdesk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_CONTACT_FIELDPermanently delete a custom contact field from Freshdesk. Use this action when you need to remove a custom contact field that is no longer needed. Important notes: - This action is IRREVERSIBLE - all data stored in this field across all contacts will be permanently deleted - Only custom fields can be deleted - system/default fields (name, email, phone, etc.) cannot be deleted - If you attempt to delete a default field, the API will return an error

Input Parameters

integer
required
The unique identifier of the custom contact field to delete. Only custom contact fields can be deleted - system/default fields (like name, email, phone) cannot be deleted. You can get this ID from the ‘Get Contact Fields’ or ‘List Contact Fields’ actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_CONVERSATIONTool to permanently delete a conversation from a ticket in Freshdesk. Use when you need to remove a specific conversation from a ticket. Note: Once deleted, the conversation cannot be restored.

Input Parameters

integer
required
The unique identifier of the conversation to delete from the ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_DISCUSSION_CATEGORYPermanently deletes a forum discussion category from Freshdesk. Use this action to remove an entire discussion category. This is a destructive operation and cannot be undone. Make sure you have the correct category_id before executing. Prerequisites: - The category_id must correspond to an existing discussion category - Use FRESHDESK_LIST_DISCUSSIONS to find available category IDs Common error scenarios: - 404: Category not found (invalid category_id or already deleted) - 401: Authentication failed (invalid API key) - 403: Insufficient permissions

Input Parameters

integer
required
The unique identifier of the discussion category to delete. You can obtain this ID from the List Discussions (FRESHDESK_LIST_DISCUSSIONS) action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_DISCUSSION_COMMENTDelete a specific Freshdesk discussion comment. A 404 response is treated like a successful deletion and returns an empty result.

Input Parameters

integer
required
Comment ID - The unique identifier of the discussion comment to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_DISCUSSION_FORUMTool to permanently delete a discussion forum in Freshdesk. Use when you need to remove a specific forum. Note: Once deleted, the forum cannot be restored.

Input Parameters

integer
required
Forum ID - The unique identifier of the discussion forum to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_DISCUSSIONS_FORUMS_FOLLOWTool to unfollow/unmonitor a discussion forum in Freshdesk. Use when you need to stop monitoring a specific forum. The operation removes the following status for the specified user from the forum. This is an idempotent operation - calling it multiple times or on an already-unfollowed forum will succeed without error. Note: Following forums is typically done through the Freshdesk web UI by end users. This action allows programmatic unfollowing via API.

Input Parameters

integer
required
Discussion Forum ID - The unique identifier of the forum to unfollow
integer
required
User ID - The unique identifier of the user who wants to unfollow the forum

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_DISCUSSIONS_TOPICS_FOLLOWTool to unfollow/unmonitor a discussion topic in Freshdesk. Use when you need to stop monitoring a specific topic. The operation removes the following status for the specified user from the topic.

Input Parameters

integer
required
Discussion Topic ID - The unique identifier of the topic to unfollow
integer
required
User ID - The unique identifier of the user who wants to unfollow the topic

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_DISCUSSION_TOPICDelete a specific discussion topic from a Freshdesk forum by its ID. The operation returns an empty result and also succeeds if the topic is not found.

Input Parameters

integer
required
Topic ID - The unique identifier of the discussion topic to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_EMAIL_MAILBOXESTool to permanently delete an email mailbox from Freshdesk. Use when you need to remove an email mailbox configuration. Note: This action is irreversible. Once deleted, emails sent to the mailbox’s address will not generate tickets. Requires admin-level permissions to access the email/mailboxes endpoint.

Input Parameters

integer
required
The unique identifier of the email mailbox to delete. Once deleted, incoming emails to that mailbox will no longer create tickets in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_GROUPTool to permanently disband a group from Freshdesk. Use when you need to delete a group from your Freshdesk account. Note: Deleting a group only disbands it and does not delete the members of the group. Once disbanded, the group cannot be restored.

Input Parameters

integer
required
The unique identifier of the group to delete. Note: Deleting a group only disbands it and does not delete the members of the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_MULTIPLE_TICKETSAsynchronously deletes multiple tickets in bulk. Returns a job_id to track deletion progress. Deleted tickets are moved to Trash and can be restored within 30 days.

Input Parameters

array
required
Array of ticket IDs to delete in bulk. Example: [123, 456, 789]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_SECTIONPermanently delete an empty section from a Freshdesk ticket field. HTTP error details may be returned in the response rather than raised.

Input Parameters

integer
required
The unique identifier of the section to be deleted. Note: The section must be empty before it can be deleted.
integer
required
The unique identifier of the ticket field that contains the section to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_SKILLDelete a Freshdesk skill by its ID. The operation also reports success with a not-found message if the skill is already absent.

Input Parameters

integer
required
The unique identifier of the skill to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_SOLUTION_ARTICLETool to permanently delete a solution article and its translated versions in Freshdesk. Use when you need to remove a solution article that is no longer needed. Note: This operation is irreversible and cannot be undone.

Input Parameters

integer
required
The unique identifier of the solution article to be deleted. Note: Deleting an article will permanently remove it along with all its translated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_SOLUTION_CATEGORYPermanently delete a solution category from Freshdesk’s knowledge base. Use this tool when you need to remove a solution category that is no longer needed. This operation is irreversible and will also delete all translated versions of the category. Note: Categories containing folders may need to have their folders removed first.

Input Parameters

integer
required
The unique identifier of the solution category to delete. This ID can be obtained from the List Solution Categories or Get Solution Category actions. Deleting a category will permanently remove it along with all its translated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_SOLUTION_FOLDERTool to permanently delete a solution folder and its translated versions in Freshdesk. Use when you need to remove a solution folder that is no longer needed. Note: This operation is irreversible and cannot be undone.

Input Parameters

integer
required
The unique identifier of the solution folder to be deleted. Note: Deleting a folder will permanently remove it along with all its translated versions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TICKETTool to permanently delete a ticket from Freshdesk. Use when you need to remove a ticket from your Freshdesk account. Note: Once deleted, the ticket cannot be restored.

Input Parameters

integer
required
The unique identifier of the ticket to delete. This permanently removes the ticket from Freshdesk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TICKET_FIELDPermanently delete a custom ticket field from Freshdesk. Use this tool when you need to remove a custom ticket field that is no longer needed. This action is irreversible and will delete all data stored in that field across all tickets. Important: Only custom fields (those with ‘cf_’ prefix) can be deleted. Default system fields like ‘subject’, ‘status’, ‘priority’, etc. cannot be deleted and will return an error.

Input Parameters

integer
required
The unique identifier of the custom ticket field to delete. Only custom fields (those with ‘cf_’ prefix in their name) can be deleted. Default system fields cannot be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TICKET_FORMTool to permanently delete a ticket form from Freshdesk. Use when you need to remove a ticket form that is no longer needed. Note: This action is irreversible and once deleted, the ticket form cannot be restored through standard API operations.

Input Parameters

integer
required
The unique identifier of the ticket form to be deleted. This action permanently deletes the ticket form and is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TICKET_FORMSTool to permanently delete a specific field from a ticket form in Freshdesk. Use when you need to remove a custom field that is no longer needed from a ticket form. Note: This action is irreversible and only custom fields can be deleted, not default fields which are interlinked with system functionalities.

Input Parameters

integer
required
The unique identifier of the ticket form containing the field to be deleted.
integer
required
The unique identifier of the specific field to be deleted from the ticket form. Note: Only custom fields can be deleted, not default fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TICKET_SUMMARYTool to delete the AI-generated summary of a ticket in Freshdesk. Use when you need to remove a ticket’s summary. Note: Once deleted, the summary cannot be restored.

Input Parameters

integer
required
The unique identifier of the ticket whose AI-generated summary should be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TICKET_USER_ACCESSTool to remove all agent access from a specific ticket in Freshdesk. Use when you need to revoke all agent permissions from a ticket. This removes all user accesses that were previously granted via the Add Ticket User Access endpoint.

Input Parameters

integer
required
The unique identifier of the ticket to remove all user accesses from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_DELETE_TIME_ENTRYTool to permanently delete a time entry from Freshdesk. Use when you need to remove a specific time entry. Note: Once deleted, the time entry cannot be restored.

Input Parameters

integer
required
The unique identifier of the time entry to be deleted. This operation permanently deletes the time entry and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_EXPORT_CONTACTSTool to initiate an asynchronous export of contacts from Freshdesk to CSV file. Use when you need to export contact data for backup, sync with external databases, or data analysis. The API returns an export job ID which can be used to retrieve the download URL once processing completes.

Input Parameters

object
required
Configuration object specifying which fields to include in the contact export. Must contain at least default_fields array. Contains default_fields (array of standard field names) and optionally custom_fields (array of custom field names). Invalid or misspelled field names cause export failure; validate names against your Freshdesk account’s configured field metadata before submitting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_ACCOUNTTool to view Freshdesk account information. Use when you need to retrieve comprehensive account details including organization information, agent counts, timezone, data center location, plan tier, address, and primary contact information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_AGENTTool to retrieve detailed information about a specific agent by ID. Use when you need to view a particular agent’s profile, contact information, availability status, and role assignments.

Input Parameters

integer
required
The unique identifier of the agent to retrieve. Use FRESHDESK_GET_AGENTS to list all agents and obtain valid agent IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_AGENT_AVAILABILITYTool to retrieve availability information for a specific agent. Use when you need to check an agent’s availability across different channels, their assignment limits, and current workload.

Input Parameters

integer
required
The unique identifier of the agent whose availability information is to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_AGENTSTool to search for agents using autocomplete functionality in Freshdesk. Use when you need to quickly find agents by name or email keyword for autocomplete suggestions.

Input Parameters

string
required
The search keyword to find agents by name or email. Minimum 2 characters recommended for meaningful results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_BUSINESS_HOURSRetrieve Freshdesk business hours configurations, including available schedules, time zones, and default indicators. Authentication, permission, or rate-limit errors return an empty list with success set to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_CANNED_RESPONSE_FOLDERRetrieve one canned response folder and its response summaries.

Input Parameters

integer
required
ID of the canned response folder to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_CANNED_RESPONSE_FOLDERSTool to retrieve all canned response folders from Freshdesk. Use when you need to list available folders for organizing canned responses. Note: Empty folders (folders without canned responses) are not listed in the API response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_COMPANIESTool to retrieve all companies from a Freshdesk account with pagination support. Use when you need to list companies representing customer organizations.

Input Parameters

integer
Page number for pagination. Starts at 1. Default: 1.
integer
Number of companies to return per page. Maximum: 100. Default: 30. Invalid values or values greater than 100 will result in an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_COMPANYTool to retrieve detailed information about a specific company by ID. Use when you need to view a particular company’s details, domains, and custom fields.

Input Parameters

integer
required
The unique identifier of the company to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_COMPANY_FIELDSTool to retrieve all company fields configured in Freshdesk. Use when you need to get the complete list of company field definitions including default fields (name, description, domains, etc.) and custom fields with their metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_CONTACTTool to retrieve detailed information about a specific contact by ID. Use when you need to view a particular contact’s profile, contact information, and custom fields.

Input Parameters

integer
required
The unique identifier of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_CONTACT_FIELDSTool to retrieve all contact fields configured in Freshdesk. Use when you need to get the complete list of contact field definitions including default fields (name, email, phone, etc.) and custom fields with their metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_CONTACTSTool to retrieve all contacts from a Freshdesk account. Use when you need to list contacts, optionally filtered by email, phone, mobile, company, state, or modification date. Results are paginated; iterate through pages using page and per_page (max 100) to retrieve the full dataset.

Input Parameters

integer
Page number for pagination. Starts at 1. Default: 1.
string
Filter contacts by email address
string
Filter contacts by phone number. Should contain only numeric values; avoid characters like ’-’, ’+’, ’(’, ’)’
string
Filter contacts by state
string
Filter contacts by mobile number. Should contain only numeric values; avoid characters like ’-’, ’+’, ’(’, ’)’
integer
Number of contacts to return per page. Maximum: 100. Default: 30.
integer
Filter contacts belonging to a specific company by company ID
string
Retrieve contacts modified after a specified timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_DISCUSSION_CATEGORYTool to view details of a specific forum category in Freshdesk. Use when you need to retrieve information about a discussion category including its name, description, and timestamps.

Input Parameters

integer
required
The unique identifier of the discussion category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_DISCUSSION_TOPICTool to retrieve detailed information about a specific discussion topic by ID. Use when you need to view a topic’s details, status, and metadata.

Input Parameters

integer
required
The unique identifier of the discussion topic to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_EMAIL_MAILBOXTool to retrieve detailed information about a specific email mailbox by ID. Use when you need to view configuration details, status, and settings of a particular email mailbox.

Input Parameters

integer
required
The unique identifier of the email mailbox to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_FOLDER_RESPONSESTool to retrieve all canned responses within a specific folder in Freshdesk. Use when you need to list all response templates stored in a particular folder.

Input Parameters

integer
required
The unique identifier of the canned response folder

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_IMPORTED_CONTACTSTool to retrieve details of all contact import operations in Freshdesk. Use when you need to view import history, check import status, or get information about failed imports.

Input Parameters

string
Filter imported contacts by status. Valid values: ‘completed’, ‘blocked’, ‘failed’, ‘cancelled’, ‘in_progress’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_JOBTool to view the status of a bulk job operation. Use when you need to check the status of bulk ticket updates or bulk ticket deletions.

Input Parameters

string
required
Job ID (UUID format) returned from bulk operations like bulk ticket updates or bulk ticket deletions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_SCENARIO_AUTOMATIONS_JSONList scenario-based automations in the Freshdesk account and retrieve their configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_SEARCHTool to search and filter tickets in Freshdesk using flexible query syntax. Use when you need to find tickets based on status, priority, tags, custom fields, dates, or other ticket attributes with complex filtering logic.

Input Parameters

integer
Page number for pagination. Starts at 1 and cannot exceed 10. Default: 1. Each page returns up to 30 results. Maximum 300 tickets can be retrieved across all pages.
string
required
Query string to filter tickets using field:value syntax. Wrap conditions in parentheses for grouping. Use AND, OR for logic. Use :> (≥) and :< (≤) for numeric/date comparisons. Use null for empty fields. String values need single quotes. Do NOT include outer double quotes - they are added automatically. Max 512 characters. Common searchable fields: status (2=Open, 3=Pending, 4=Resolved, 5=Closed), priority (1=Low, 2=Medium, 3=High, 4=Urgent), agent_id, group_id, tag, created_at, updated_at, due_by. Custom fields use cf_ prefix. Note: Not all fields are searchable (e.g., requester_id may not work); use FRESHDESK_LIST_TICKET_FIELDS to discover available searchable fields. Dates in UTC (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_TICKETSRetrieves a list of tickets from Freshdesk. Tickets are returned under response_data in the response object.

Input Parameters

integer
Page number to retrieve
string
Predefined filter to apply. Possible values include ‘new_and_my_open’, ‘watching’, ‘spam’, ‘deleted’, etc.
string ("open" | "pending" | "resolved" | "closed" | "waiting_on_customer" | "waiting_on_third_party")
Enum for ticket status values.
string
Field to sort tickets by, e.g., ‘created_at’
integer
Filter tickets by agent ID
integer
Filter tickets by group ID
integer
Number of tickets per page
string ("low" | "medium" | "high" | "urgent")
Enum for ticket priority values.
string
Order of sorting: ‘asc’ or ‘desc’
integer
Filter tickets by requester ID
string
Retrieve tickets created since this timestamp. Format: YYYY-MM-DDTHH:MM:SSZ

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_TICKET_TIME_ENTRIESRetrieve a page of time entries for a specific Freshdesk ticket to view its associated time logs.

Input Parameters

integer
Page number for pagination. Default is 1.
integer
required
The unique identifier of the ticket to retrieve time entries for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_TICKET_USER_ACCESSTool to retrieve agent access information for a specific ticket in Freshdesk. Use when you need to check which agents have permission to view or interact with a ticket. Returns a list of agent IDs that have access to the specified ticket.

Input Parameters

integer
required
The unique identifier of the ticket to retrieve user access information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_GET_TRANSLATED_SOLUTION_CATEGORYTool to view a translated solution category in Freshdesk. Use when you need to retrieve a solution category in a specific language other than the default language.

Input Parameters

integer
required
The ID of the solution category
string
required
The language code for the translated category (e.g., ‘en’, ‘es’, ‘fr’, ‘de’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_HARD_DELETE_CONTACTTool to permanently delete a contact from Freshdesk. Use when you need to completely remove a contact’s profile, tickets, calls, forum topics, ratings, and notes (useful for GDPR compliance). By default, the contact must be soft-deleted first unless force=true is used. This deletion is irreversible.

Input Parameters

boolean
If true, force delete a contact even if it is not soft deleted previously. Default value is false.
integer
required
The unique identifier of the contact to be permanently deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_IMPORT_CONTACTTool to import contacts in bulk from a CSV file to Freshdesk. Use when you need to create multiple contacts at once from a CSV file with field mappings.

Input Parameters

object
CSV file containing contact data to import. File must be UTF-8 encoded with first row as headers.
string
Inline CSV file content to upload as bytes or UTF-8 string.
string
Filename for the inline content (e.g., ‘contacts.csv’). Defaults to ‘import.csv’.
string
MIME type for the inline content (e.g., ‘text/csv’). Defaults to text/csv.
integer
required
Zero-based column index for contact name field in the CSV file (e.g., 0 for first column, 1 for second column)
integer
required
Zero-based column index for email address field in the CSV file
integer
Zero-based column index for contact job title field in the CSV file (optional)
integer
required
Zero-based column index for company name field in the CSV file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_ADMIN_GROUPSList a page of Freshdesk admin groups, including available member IDs, escalation settings, and configuration details. Page and page size can be specified.

Input Parameters

integer
Page number for pagination (default: 1)
integer
Number of groups to return per page (default: 30, max: 100)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_ALL_AGENTS_IN_A_GROUPTool to retrieve all agents associated with a specific group in Freshdesk. Use when you need to get the list of agents assigned to a particular group.

Input Parameters

integer
required
The unique identifier of the group whose agents you want to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_ALL_SECTIONS_FOR_TICKET_FIELDTool to retrieve all dynamic sections for a specific ticket field in Freshdesk. Use when you need to view all sections associated with a dropdown field that controls dynamic field visibility.

Input Parameters

integer
required
The unique identifier of the ticket field for which to retrieve all sections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_ALL_SKILLSTool to retrieve all skills configured in Freshdesk account. Use when you need to get the complete list of skills available for ticket routing and agent assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_ALL_TICKET_CONVERSATIONSList conversations for a specific Freshdesk ticket, including messages, notes, and replies. Results are paginated, with page and page size selectable.

Input Parameters

integer
Page number for pagination. Used to retrieve specific pages of results when there are many conversations.
integer
Number of items per page for pagination. Controls how many conversation records are returned per page.
integer
required
The unique identifier of the ticket whose conversations are to be retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_AUTOMATION_RULESTool to list all automation rules for a specific automation type in Freshdesk. Use when you need to retrieve all automation rules for ticket creation, time-based triggers, or ticket updates.

Input Parameters

integer
required
The automation type ID. Valid values: 1 (ticket creation rules - triggered when a ticket is created), 3 (time-based triggers - run on schedule based on ticket state), 4 (ticket update rules - triggered when a ticket is updated). Note: type 2 is not accessible via API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_DISCUSSIONSTool to retrieve all forum categories (discussions) from Freshdesk. Use when you need to list all discussion categories available in the account. Supports pagination via page parameter.

Input Parameters

integer
Page number for pagination. Starts with 1. Used to scroll through paginated responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_DISCUSSIONS_TOPICSRetrieve discussion topics within a specified Freshdesk forum, with pagination.

Input Parameters

integer
Page number for pagination. Starts with 1. Default: 1
integer
required
The unique identifier of the forum whose topics you want to retrieve
integer
Number of topics to retrieve per page. Min: 1, Max: 100, Default: 30

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_EMAILTool to retrieve all email mailbox configurations from Freshdesk account. Use when you need to view support email addresses, mailbox settings, or filter mailboxes by product, group, or status.

Input Parameters

integer
Page number for pagination (default: 1)
boolean
Filter by active status - true for active mailboxes, false for inactive
integer
Filter mailboxes by associated group ID
string
Order results by specific field. Allowed values: ‘group_id’, ‘product_id’, ‘failure_code’, ‘public_domain_failure’
integer
Number of records per page (default: 30, maximum: 100)
string
Sort order - ‘asc’ for ascending or ‘desc’ for descending
integer
Filter mailboxes by associated product ID
string
Filter by specific support email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_EMAIL_CONFIGSRetrieve all email configurations from a Freshdesk account. Returns a list of email configs including support email addresses, associated products, groups, and active status. Useful for viewing mailbox configurations or finding email config IDs needed for other operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_FORUMS_IN_CATEGORYTool to retrieve all forums within a specified category in Freshdesk. Use when you need to list all forums that exist within a specific forum category. Supports pagination via page and per_page parameters.

Input Parameters

integer
Page number for pagination. Starts with 1. Used to scroll through paginated responses.
integer
Number of results per page. Default and maximum limits apply based on endpoint.
integer
required
The unique identifier of the forum category for which to retrieve forums

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_GROUPSList one page of standard Freshdesk support groups.

Input Parameters

integer
Page number, starting at 1.
integer
Number of groups to return per page, from 1 to 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_MONITORED_TOPICSTool to retrieve all discussion topics that are monitored/followed by a specific user in Freshdesk. Use when you need to list topics a user is following.

Input Parameters

integer
Page number for pagination. Starts with 1. Used to scroll through paginated responses.
integer
The ID of the user whose followed/monitored topics to retrieve. If not provided, returns topics for the authenticated user (from API key). Only admins can query other users’ monitored topics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_PARTICIPATED_TOPICSTool to retrieve discussion topics that a user has participated in by creating or commenting. Use when you need to list topics where a specific user has been active. Only admins can fetch topics for other users; without user_id, returns authenticated user’s topics.

Input Parameters

integer
Page number for pagination. Starts with 1. Used to scroll through paginated responses.
integer
The ID of the user whose participated topics to retrieve. If not provided, returns topics for the authenticated user (from API key). Only admins can query other users’ participated topics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_PRODUCTSTool to retrieve all products configured in Freshdesk account. Use when you need to get the complete list of products available for support and ticket categorization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_ROLESList Freshdesk roles for agents and collaborators, with pagination and role details.

Input Parameters

integer
Page number for pagination (starts from 1)
integer
Number of results per page. Default is 30, maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SATISFACTION_RATINGSTool to retrieve all customer satisfaction survey ratings from Freshdesk. Use when you need to view satisfaction ratings, optionally filtered by creation date. By default, only returns results from the previous month unless created_since parameter is specified.

Input Parameters

integer
Page number for pagination. Default: 1. Used to scroll through pages of results.
integer
Number of results to return per page. Default: 30. Maximum: 100. Invalid values or values greater than 100 will result in an error.
string
Filter satisfaction ratings created after this timestamp. Format: ISO 8601 datetime (YYYY-MM-DDTHH:MM:SSZ in UTC). Example: 2019-03-25T00:00:00Z. Without this parameter, only results from the previous month are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SLA_POLICIESTool to retrieve all SLA (Service Level Agreement) policies in Freshdesk. Use when you need to get the complete list of SLA policies with their configurations, targets, and applicability conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SOLUTION_ARTICLESList a page of solution articles in a specified Freshdesk folder. Check the success flag and message to distinguish errors from an empty list.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 articles.
integer
required
The unique identifier of the solution folder for which to retrieve articles

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SOLUTION_CATEGORIESList a page of Freshdesk solution categories. Check the success flag and message to distinguish errors from an empty list.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SOLUTION_FOLDERSList a page of folders within a specified Freshdesk solution category. Check the success flag and message to distinguish errors from an empty list.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 folders.
integer
required
The unique identifier of the solution category for which to retrieve folders

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SOLUTIONS_CATEGORY_FOLDERS_TRANSLATEDList a page of translated solution folders in a Freshdesk category for a specified language.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 folders.
integer
required
The unique identifier of the solution category for which to retrieve translated folders
string
required
The language code for the translated folders (e.g., ‘en’ for English, ‘es’ for Spanish, ‘fr’ for French). Must be a valid ISO language code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SOLUTION_SUBFOLDERSList a page of subfolders within a specified Freshdesk solution folder.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 subfolders.
integer
required
The unique identifier of the parent folder whose subfolders you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SPECIFIC_SECTION_DETAILSTool to retrieve details of a specific section within a ticket field in Freshdesk. Use when you need to view information about a particular dynamic section including its label, associated choices, and contained fields.

Input Parameters

integer
required
The unique identifier of the specific section to retrieve details for.
integer
required
The unique identifier of the parent ticket field that contains the section.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_SURVEYSList surveys in a Freshdesk account, optionally filtered by active, draft, or paused state.

Input Parameters

string ("active" | "draft" | "paused")
Filter surveys by their current state. Use ‘active’ for active surveys, ‘draft’ for draft surveys, or ‘paused’ for paused surveys. Only one survey can be active at any given time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TICKET_FIELDSTool to list all ticket fields configured in Freshdesk. Use when you need to retrieve metadata about all ticket field definitions including both default and custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TICKET_FORMSTool to retrieve all ticket forms from Freshdesk. Use when you need to view the list of available ticket forms, optionally with pagination or portal associations.

Input Parameters

integer
Page number for pagination. Page numbers start with 1.
string
Fetches additional data. Use ‘portals’ to include portal associations with each ticket form.
integer
Number of ticket forms to retrieve per page. Maximum is 50, default is 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TICKET_SATISFACTION_RATINGSList a page of satisfaction ratings for a specific Freshdesk ticket, including customer feedback and survey responses.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of results per page. Default: 30, Maximum: 100
integer
required
The unique identifier of the ticket whose satisfaction ratings should be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TICKETS_WATCHERSTool to list all watchers subscribed to a specific Freshdesk ticket. Use when you need to see who is following a ticket and receiving notifications for updates.

Input Parameters

integer
required
ID of the ticket to retrieve watchers for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TIME_ENTRIESTool to retrieve all time entries from Freshdesk with optional filtering by company, agent, execution time range, and billable status. Use when you need to view time logs across tickets with support for pagination.

Input Parameters

integer
Page number for pagination. Default is 1. Avoid page numbers over 500 for performance reasons.
integer
Filter time entries by specific agent ID
boolean
Filter by billable status (true for billable, false for non-billable)
integer
Number of entries per page. Default is 30, maximum is 100.
integer
Filter time entries by company ID
string
Filter time entries executed after specified date/time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) in UTC
string
Filter time entries executed before specified date/time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) in UTC

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TOPIC_COMMENTS2Tool to list all comments on a specific discussion topic with pagination support. Use when you need to retrieve comments from a topic with control over page size and pagination.

Input Parameters

integer
required
The ID of the topic whose comments you want to retrieve
integer
Page number for pagination (default: 1, max: 10)
integer
Number of items per page (default: 30)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TRANSLATED_SOLUTION_ARTICLESLists translated solution articles in a Freshdesk folder for a specified language. Results are retrieved one page at a time.

Input Parameters

integer
required
The unique identifier of the solution folder
integer
Page number for pagination. Starts at 1. Each page returns up to 30 articles.
string
required
Language code for the translated articles (e.g., ‘en’, ‘es’, ‘fr’, ‘de’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_LIST_TRANSLATED_SUBFOLDERSLists translated subfolders of a Freshdesk parent folder for a specified language. Results are retrieved one page at a time.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 subfolders.
integer
required
The unique identifier of the parent folder to retrieve subfolders from
string
required
The language code for the translated folders (e.g., ‘en’ for English, ‘es’ for Spanish, ‘fr’ for French)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_MERGE_TICKETSIrreversibly merge duplicate tickets into one retained primary ticket.

Input Parameters

integer
required
ID of the ticket to retain.
array
required
IDs of secondary tickets to merge into the primary ticket.
object
Note to add to the retained primary ticket.
object
Note to add to each secondary ticket.
boolean
Whether to add secondary-ticket recipients as CCs on the primary ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_PATCH_ADMIN_GROUPS_AGENTSTool to add or remove agents in a Freshdesk group. Use when you need to modify the list of agents assigned to a specific group by providing an array of agent IDs.

Input Parameters

integer
required
The unique identifier of the group to modify
array
required
Array of agent IDs to set for the group. This replaces the current list of agents in the group. Pass an empty array to remove all agents from the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_REMOVE_WATCHERTool to remove the authenticated user as a watcher from a Freshdesk ticket. Use when you need to stop receiving email notifications for ticket updates like replies or status changes. The API automatically uses the authenticated user’s credentials and does not require additional parameters.

Input Parameters

integer
required
The unique identifier of the ticket to remove the watcher from. The authenticated user will be removed as a watcher from this ticket.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_REPLY_TO_FORWARD_TICKETTool to reply to or forward a ticket to external email addresses. Use when you need to send a ticket reply to specific email recipients outside the normal ticket flow.

Input Parameters

string
required
Content of the reply or forward message
array
List of email addresses to be CC’d
integer
required
ID of the ticket to reply to or forward
array
required
List of email addresses to send the reply/forward to
array
List of email addresses to be BCC’d
string
Email address from which the reply should be sent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_REPLY_TO_TICKETCreate a public reply to an existing Freshdesk support ticket, with plain text or HTML content and optional sender and recipient controls.

Input Parameters

string
required
The content of the reply message. Can contain HTML formatting. This is the primary reply content that will be sent to the requester.
integer
The ID of the agent creating the reply. Use this to create a reply on behalf of a specific user. Can also be used to create a reply as if it came from the customer.
array
Email addresses to include in the CC field of the reply. Maximum 50 total recipients across to/cc/bcc fields.
integer
required
The unique identifier of the ticket to reply to
array
Direct recipient email addresses to override the default ticket requester. Requires the ‘multiple_to’ feature to be enabled in your Freshdesk account. When not using this feature, the reply is automatically sent to the ticket requester.
array
Email addresses to include in the BCC field of the reply. Maximum 50 total recipients across to/cc/bcc fields.
string
The support email address to send the reply from. If you have multiple support emails configured, use this parameter to specify which email should be used as the sender. By default, replies are sent from the support email where the ticket was originally created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_SEARCH_AGENTSTool to search and filter agents in Freshdesk. Use when you need to find agents by email, phone, mobile, or state (fulltime/occasional).

Input Parameters

integer
Specifies which page of results to return
string
Filter agents by email address
string
Filter agents by phone number
string ("fulltime" | "occasional")
Filter agents by their state (fulltime or occasional)
string
Filter agents by mobile phone number
integer
Specifies the number of results per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_SEARCH_COMPANIESTool to search and filter companies in Freshdesk using query strings with custom fields. Use when you need to find companies based on searchable fields like created_at, updated_at, or custom company fields. Note: Standard fields like ‘name’ are NOT searchable and will cause validation errors.

Input Parameters

integer
Page number for pagination. Starts at 1 and should not exceed 10. Default: 1. Maximum 300 results can be returned across all pages (30 per page).
string
required
URL-encoded query string to filter companies. Format: “(field:value OR field:‘string’) AND field:boolean”. Must be enclosed in double quotes and limited to 512 characters. Note: Only custom fields and certain system fields like ‘created_at’ are searchable. Standard fields like ‘name’ are NOT supported and will cause validation errors. Use relational operators :> (greater than or equal) and :< (less than or equal) for numeric and date fields. Example: “created_at:>‘2020-01-01’” or “(custom_field_1:100 OR custom_field_2:‘value’)“

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_SEARCH_COMPANYSearch Freshdesk companies by name or partial name using autocomplete to find matching company suggestions.

Input Parameters

string
required
The company name or partial name to search for. Use this parameter to find companies matching the search term via autocomplete functionality.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_SEARCH_CONTACTSTool to search and filter contacts in Freshdesk using query-based search. Use when you need to find contacts based on fields like email, phone, mobile, company_id, or other searchable contact attributes.

Input Parameters

integer
Page number for pagination. Starts at 1 and cannot exceed 10. Default: 1. Returns maximum 30 results per page.
string
required
Query string to filter contacts. IMPORTANT: The entire query must be wrapped in double quotes. Format: “field:value” for strings or “field:number” for numeric values. Searchable fields: email, phone, mobile, company_id, active. Supports logical operators (AND, OR) for combining conditions. String values must use single quotes inside the double-quoted query. Limited to 512 characters. Use “field:null” to search for null values. Note: The search API requires exact matches; partial/regex searches are not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_SEARCH_CONTACTS_AUTOCOMPLETETool to search for contacts using autocomplete functionality in Freshdesk. Use when you need to quickly find contacts by name, email, or other contact attributes for autocomplete suggestions.

Input Parameters

string
required
Search term to find matching contacts. The endpoint searches across contact name, email, and other contact fields to return matches for autocomplete suggestions. Minimum 1 character required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_SEARCH_SOLUTION_ARTICLESTool to search solution articles in Freshdesk knowledge base by keyword. Use when you need to find articles by searching titles and content.

Input Parameters

integer
Page number for pagination. Starts at 1. Each page returns up to 30 results (max 10 pages).
string
required
The search term or keyword to search for in solution articles. Searches across article titles and body content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_TOGGLE_TIMERTool to toggle the timer on a time entry to start or stop time tracking. Use when you need to start tracking time on a stopped timer or stop a currently running timer.

Input Parameters

integer
required
The unique identifier of the time entry to toggle the timer on. The timer will start if currently stopped, or stop if currently running.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_ADMIN_GROUPTool to update an existing admin-level support agent group in Freshdesk. Use when you need to modify group details such as name, description, assigned agents, or escalation settings at the admin level.

Input Parameters

integer
required
The unique identifier of the admin group to update
string
The name of the group. Must be unique within the Freshdesk account.
array
Array of agent IDs who should be members of this group.
string
A brief description of the group’s purpose and responsibilities.
integer
ID of the group to which unassigned tickets should be escalated after the specified time period.
string
Time period after which an unassigned ticket in the group should be escalated. Format examples: ‘30m’, ‘1h’, ‘2h’, ‘8h’, ‘1d’.
integer
ID of the business calendar associated with this group for calculating business hours.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_ADMIN_TICKET_FIELDTool to update an existing ticket field configuration in Freshdesk. Use when you need to modify field properties such as labels, visibility settings, or requirement flags.

Input Parameters

integer
required
The ID of the ticket field to update
string
The agent-facing label for the ticket field. This is what agents see in the UI.
integer
The display position/order of the field in the form. Lower numbers appear first.
boolean
Whether customers can edit this field after ticket creation.
string
The customer-facing label for the ticket field. This is displayed to customers in the portal.
boolean
Whether this field is required for agents when creating or updating tickets.
boolean
Whether this field is required when closing a ticket.
boolean
Whether this field is displayed to customers in the support portal.
boolean
Whether this field is required for customers when submitting tickets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_ADMIN_TICKET_FIELD_SECTIONTool to update a section within a ticket field in Freshdesk. Use when you need to modify section properties like label, associated choices, or contained fields.

Input Parameters

integer
required
The ID of the parent ticket field that contains the section
string
The display label for the section
array
Array of choice IDs from the parent ticket field that trigger this section. These are the dropdown options that determine when the section appears
integer
required
The ID of the section to update
array
Array of ticket field IDs to include in this section

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_AGENTTool to update an existing agent’s information in Freshdesk. Use when you need to modify agent details such as email, permissions, signature, skills, groups, roles, or focus mode.

Input Parameters

integer
required
The unique identifier of the agent to update
string
Email address of the Agent
string
Agent language preference, defaults to en
array
Array of role identifiers
array
Array of group identifiers
string
Signature of the agent in HTML format
array
Array of skill identifiers
string
Agent timezone setting
string ("support" | "field" | "collaborator")
Agent classification.
boolean
Focus mode toggle, defaults to true
boolean
Agent employment type indicator - true for occasional, false for full-time
string ("global_access" | "group_access" | "restricted_access")
Ticket permission scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_AGENT_AVAILABILITYTool to update agent availability settings in Freshdesk. Use when you need to modify an agent’s load settings by changing assignment limits for different channels.

Input Parameters

integer
required
The unique identifier of the agent whose availability settings are to be updated
array
required
Array of channel availability settings to update for the agent. Each object specifies the channel name and its assignment limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_AUTOMATIONSTool to update an existing automation rule in Freshdesk. Use when you need to modify automation rule properties like name, description, active status, conditions, or actions. Supports ticket creation rules (type 1), time-based triggers (type 3), and ticket update rules (type 4).

Input Parameters

integer
required
The unique identifier of the specific automation rule to update.
string
The name of the automation rule.
boolean
Whether the automation rule is active (true) or inactive (false).
array
Array of action objects that are performed when conditions are met. Each action has an action_type and associated value.
integer
The position/order of the rule in the automation sequence.
object
Conditions that must be met for the rule to execute. Typically contains an ‘all’ or ‘any’ key with an array of condition objects.
string
Description of what the automation rule does.
integer
required
The ID of the automation type. Use 1 for ticket creation rules, 3 for time-based triggers, or 4 for ticket update rules. Note: Value 2 is not allowed and will return an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_CANNED_RESPONSETool to update an existing canned response in Freshdesk. Use when you need to modify the title, content, folder location, visibility, or group access of a canned response template.

Input Parameters

integer
required
The unique identifier of the canned response to update
string
Title of the canned response
integer
ID of the folder to move this canned response to
array
Array of group IDs that should have access to this canned response. Used when visibility is set to 2 (specific groups)
integer
Visibility setting: 0=personal (visible only to creator), 1=all agents (visible to all agents), 2=specific groups (visible to designated groups)
string
HTML formatted content of the canned response. The plain text content field is automatically generated from this.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_CANNED_RESPONSE_FOLDERUpdates the name of an existing canned response folder in Freshdesk. Use this to rename folders that organize canned response templates.

Input Parameters

string
required
The new name for the canned response folder
integer
required
The unique identifier of the canned response folder to update. Use the ‘Get Canned Response Folders’ action to find folder IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_COMPANIESTool to update an existing company’s information in Freshdesk. Use when you need to modify company details, domains, or custom fields.

Input Parameters

string
Company name
string
Notes associated with the company
array
Domain names for the company. Multiple domains can be added
string
Industry classification of the company. Editable dropdown of standard industry choices. Available on Blossom plan and above
integer
required
The unique identifier of the company to update
string
Description about the company
string
Account tier for the company. Editable dropdown with choices: ‘basic’, ‘premium’, ‘enterprise’. Available on Blossom plan and above
string
Health score for the company. Editable dropdown with choices: ‘happy’, ‘doing okay’, ‘at risk’. Available on Blossom plan and above
string
Date field for contract or renewal dates in ISO 8601 format (e.g., ‘2024-12-31’). Available on Blossom plan and above
object
Custom field values specific to your Freshdesk configuration. Available on Growth plan or above

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_CONTACTTool to update an existing contact’s information in Freshdesk. Use when you need to modify contact details such as name, email, phone, job title, or custom fields.

Input Parameters

integer
required
ID of the contact to update
string
Updated name of the contact
array
Updated tags associated with the contact
string
Updated email address
string
Updated phone number
string
Updated mobile number
string
Updated physical address
string
Updated language code for preferred language
string
Updated job title
string
Updated time zone
integer
Updated ID of the primary company associated with this contact
string
Updated Twitter handle
string
Updated description or notes about the contact
array
Updated additional email addresses
object
Custom fields object. Note: If contact has required custom fields (e.g., employee_id), they must be included in updates to avoid validation errors.
boolean
Set to true if the contact can view all tickets from their company
string
Updated external ID for integration purposes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_CONTACT_FIELDTool to update a contact field’s configuration in Freshdesk. Use when you need to modify field properties like labels, requirements, or visibility settings for agents and customers.

Input Parameters

string
Display label shown to agents for this contact field
integer
required
The unique identifier of the contact field to update
boolean
Whether customers can edit this field
string
Display label shown to customers for this contact field
boolean
Whether the field is required for agents to fill out
boolean
Whether the field is required for customers to fill out
boolean
Whether the field is displayed to customers

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_CONTACT_MAKE_AGENTTool to convert a contact into an agent in Freshdesk. Use when you need to grant a contact access to the helpdesk as an agent with specific permissions and roles.

Input Parameters

integer
required
ID of the contact to convert to an agent
array
required
Array of role IDs that determine the agent’s permissions. At least one role ID is required.
boolean
Specifies whether the agent is an occasional agent (true) or a full-time agent (false). Defaults to false if not specified.
integer
required
Ticket scope defines the level of access: 1 (Global access - all tickets), 2 (Group access - tickets assigned to agent or their group), 3 (Restricted access - only tickets assigned to agent)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_CONVERSATIONSTool to update the content of a conversation note in Freshdesk. Use when you need to modify existing public or private notes. Note: Only public and private notes can be edited, not incoming replies. The ‘private’ parameter cannot be modified.

Input Parameters

integer
required
The unique identifier of the conversation to update
string
required
The updated content of the note in HTML format. This parameter replaces the deprecated ‘body_html’ from API v1. Only public and private notes can be edited.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_DISCUSSION_CATEGORYTool to update an existing discussion category in Freshdesk forums. Use when you need to modify the name or description of a forum category.

Input Parameters

integer
required
The unique identifier of the discussion category to update
string
The name of the forum category
string
The description of the forum category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_DISCUSSION_COMMENTTool to update an existing comment in a discussion forum. Use when you need to edit the content of a comment in Freshdesk discussions.

Input Parameters

integer
required
The unique identifier of the discussion comment to update
string
required
The updated content of the comment. Can contain HTML formatting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_DISCUSSION_FORUMTool to update an existing discussion forum in Freshdesk. Use when you need to modify forum details such as name, description, category, type, or visibility settings.

Input Parameters

integer
required
The unique identifier of the discussion forum to update
string
Name of the forum
integer
Type of the forum. Valid values: 1=Questions, 2=Ideas, 3=Problems, 4=Announcements. Note: Cannot be updated if forum contains topics.
array
Array of company IDs that have access to the forum. Can only be updated when forum_visibility is set to 4 (Selected companies).
string
Description of the forum
integer
Visibility setting for the forum. Valid values: 1=Everyone, 2=Logged in users, 3=Agents only, 4=Selected companies.
integer
ID of the forum category to assign the forum to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_DISCUSSION_TOPICTool to update an existing discussion topic in Freshdesk. Use when you need to modify a topic’s title, message, lock status, or other properties.

Input Parameters

integer
required
The unique identifier of the discussion topic to update
string
The topic’s title
boolean
Controls whether the topic is locked. When true, no new replies can be added.
boolean
Whether the topic is pinned/sticky. Pinned topics appear at the top of the forum.
string
If included, updates the first comment/post of the topic. Supports HTML formatting.
integer
ID of the forum to move the topic to. Can only be updated if user has privilege to manage forums.
string
Type of stamp/badge for the topic. Used to mark topics with special designations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_EMAIL_SETTINGSTool to update mailbox settings for email handling in Freshdesk. Use when you need to configure email behavior such as personalized replies, ticket threading, auto-response detection, or agent conversation settings.

Input Parameters

boolean
Allow multiple email addresses in the To field when sending outbound emails from Freshdesk
boolean
Enable ticket threading based on matching email subject lines
boolean
Enable extended quoted text detection to better identify and handle quoted content in email replies
boolean
Disable automatic ticket threading based on email conversation history
boolean
Enable or disable personalized email replies. When enabled, emails to customers will include personalized content
boolean
Allow tickets to be created when emails are sent to wildcard addresses configured in your mailbox
boolean
Enable email threading without validating that the sender matches the original requester
boolean
Enable automatic detection of auto-response emails to prevent automatic replies from creating tickets or updating existing ones
boolean
Create requester using the Reply-To address instead of the From address when processing incoming emails
boolean
Enable email threading without requiring a ticket ID in the email subject or references
boolean
Allow agents to initiate new email conversations with customers directly from Freshdesk
boolean
Set the original sender as the requester when emails are forwarded to Freshdesk

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_NOTIFICATION_EMAIL_BCCTool to update automatic BCC email addresses for all ticket communications in Freshdesk. Use when you need to configure which email addresses should automatically receive BCC copies of all outgoing emails.

Input Parameters

array
required
Array of email addresses to set as automatic BCC recipients for all ticket communications. Maximum 50 email addresses allowed with a total limit of 255 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_SLA_POLICIESTool to update an existing SLA (Service Level Agreement) policy in Freshdesk. Use when you need to modify service level targets, policy settings, or applicability conditions for an SLA policy.

Input Parameters

integer
required
Unique identifier of the SLA policy to update
string
Name of the SLA policy
boolean
Whether the SLA policy is active or not
object
SLA targets for different priority levels.
string
Description of the SLA policy
object
Conditions that determine where the SLA policy applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_SOLUTION_CATEGORYTool to update an existing solution category in Freshdesk. Use when you need to modify the name or description of a solution category.

Input Parameters

string
The name of the solution category
integer
required
The unique identifier of the solution category to update
string
A description of the solution category and its purpose

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_SOLUTION_FOLDERTool to update an existing solution folder in Freshdesk knowledge base. Use when you need to modify folder properties such as name, description, visibility settings, or folder hierarchy.

Input Parameters

string
Name of the solution folder
integer
required
The unique identifier of the solution folder to update
integer
Visibility setting for the folder (1=All users, 2=Logged in users, 3=Selected companies, 4=Selected contacts)
array
Array of company IDs associated with the folder. Used when visibility is set to selected companies.
string
Description of the solution folder
string
Optional language code for multilingual folder translation (e.g., ‘en’, ‘es’, ‘fr’). When provided, updates the folder in that specific language.
integer
ID of the parent folder for creating folder hierarchy. Set to null or omit to make it a top-level folder.
array
Array of company segment IDs for segmentation
array
Array of contact segment IDs for customer segmentation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_SOLUTIONSUpdate a Freshdesk solution article by ID, including its title, description, status, tags, or SEO metadata. A language code can target a translated article; include only fields to update.

Input Parameters

integer
required
The unique identifier of the solution article to update
array
Tags for the article
string
Title of the solution article
integer
Status of the article (1=Draft, 2=Published). To unpublish an article, pass status as 1.
integer
Agent ID associated with the article
object
Meta data for search engine optimization containing meta_title, meta_description, and meta_keywords (array)
string
Description/content of the article in HTML format
string
Optional language code for updating translated articles (e.g., ‘en’, ‘es’, ‘fr’). If specified, updates the article in that language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_TICKETTool to update an existing ticket in Freshdesk. Use when you need to modify ticket attributes like subject, priority, status, description, or custom fields.

Input Parameters

string
Name of the requester.
array
Array of tags to associate with the ticket.
string
Type of the ticket. Default types: Question, Incident, Problem, Feature Request. Custom types configured in your Freshdesk instance (e.g., Billing, Refund, Bug, Enhancement) are also supported.
string
Email address of the requester.
string
Phone number of the requester.
string
Timestamp when the ticket is due to be resolved in ISO 8601 format (e.g., ‘2026-01-30T15:00:00Z’).
string ("email" | "portal" | "phone" | "forum" | "twitter" | "facebook" | "chat" | "mobihelp" | "feedback_widget" | "outbound_email")
Enum for ticket source values.
string ("open" | "pending" | "resolved" | "closed" | "waiting_on_customer" | "waiting_on_third_party")
Enum for ticket status values.
string
Subject of the ticket.
integer
ID of the group to which the ticket has been assigned.
string ("low" | "medium" | "high" | "urgent")
Enum for ticket priority values.
string
Timestamp when the first response is due in ISO 8601 format (e.g., ‘2026-01-28T15:00:00Z’).
integer
ID of the parent ticket to link this ticket to.
integer
required
ID of the ticket to be updated.
integer
ID of the company associated with the requester.
integer
ID of the product associated with this ticket.
string
Twitter handle of the requester.
array
Array of attachment objects to add to the ticket.
string
HTML content of the ticket description.
string
Facebook ID of the requester.
integer
User ID of the requester.
integer
ID of the agent to whom the ticket has been assigned.
object
Key-value pairs containing names and values of custom fields. Example: {“cf_reference_number”: “REF-123”}. Custom fields must be predefined in Freshdesk admin settings.
integer
ID of the email configuration used for this ticket.
string
Lookup field value for custom objects.
integer
ID of the internal agent to assign the ticket to.
integer
ID of the internal group to assign the ticket to.
string
External ID of the requester.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_TICKET_BULK_WATCHAdd the authenticated user as a watcher to multiple Freshdesk tickets in one bulk operation. For a parsed partial response, the result can include succeeded and failed ticket IDs; other responses may not include those lists.

Input Parameters

array
required
Array of ticket IDs to add the authenticated user as a watcher. The authenticated user will receive email notifications for updates on all specified tickets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_TICKET_FORMSUpdate an existing Freshdesk ticket form’s title, description, or field configurations. Portal associations can optionally be included in the response.

Input Parameters

string
The display title of the ticket form shown to users and agents.
array
List of field configurations to update on the form. Each field can specify id, name, label, position, and visibility/requirement settings.
string
Additional data to include in the response. Use ‘portals’ to include portal associations.
string
Description explaining the purpose of this ticket form.
integer
required
The unique identifier of the ticket form to update. This is a required path parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_TICKET_SUMMARYTool to update the AI-generated summary of a ticket in Freshdesk. Use when you need to modify or set the summary content for a ticket. The summary provides a concise overview of the ticket’s content and history.

Input Parameters

string
required
The AI-generated summary content to update for the ticket. Can contain plain text or HTML.
integer
required
The unique identifier of the ticket to update the AI-generated summary for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_TICKET_USER_ACCESSTool to update agent access to a specific ticket in Freshdesk by adding or removing agents. Use when you need to grant or revoke agent permission to view or interact with a ticket. Returns the list of agent IDs that have access after the update.

Input Parameters

integer
required
The ID of the ticket to update user access for
array
required
Array of objects containing user ID and action. Each object must have ‘id’ (integer, agent ID) and ‘action’ (string, either ‘add’ or ‘remove’) fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_UPDATE_TIME_ENTRYTool to update an existing time entry in Freshdesk. Use when you need to modify time entry details such as duration, notes, billable status, or agent assignment. Note: start_time cannot be updated if the timer is running, and timer_running cannot be set to its current value.

Input Parameters

integer
required
The unique identifier of the time entry to update. This is a required field.
string
Notes or description about the time entry. Provides context about the work performed.
integer
The ID of the agent associated with the time entry. Used to reassign the time entry to a different agent.
boolean
Boolean indicating if the time entry is billable. Set to true for billable time, false for non-billable time.
string
The start time of the time entry in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) in UTC. Note: This field cannot be updated if the timer is currently running.
string
Amount of time spent in HH:MM format (e.g., ‘02:00’ for 2 hours, ‘00:30’ for 30 minutes).
string
The date/time when the work was executed in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) in UTC.
boolean
Boolean indicating if the timer is currently running. Note: Cannot be set to the same value as before - this field is used to toggle the timer state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_A_CANNED_RESPONSETool to view details of a specific canned response in Freshdesk. Use when you need to retrieve information about a canned response including its title, content, folder location, and attachments.

Input Parameters

integer
required
The unique identifier of the canned response to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_AUTOMATIONSTool to view details of a specific automation rule in Freshdesk. Use when you need to retrieve comprehensive information about an automation rule including its triggers, conditions, and actions.

Input Parameters

integer
required
The unique identifier of the specific automation rule to retrieve.
integer
required
The automation type ID. Valid values: 1 (ticket creation rules - triggered when a ticket is created), 3 (time-based triggers - run on schedule based on ticket state), 4 (ticket update rules - triggered when a ticket is updated). Note: type 2 is not accessible via API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_BUSINESS_HOURTool to retrieve a specific business hour configuration from Freshdesk. Use when you need to view detailed information about business hours including working schedule, time zone, and holiday list.

Input Parameters

integer
required
The unique identifier of the business hour configuration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_COMPANY_FIELDTool to retrieve details of a specific company field by ID. Use when you need to view configuration and metadata for a single company field including its type, position, and choices for dropdown fields.

Input Parameters

integer
required
The unique identifier of the company field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_CONTACT_FIELDTool to retrieve details of a specific contact field by ID. Use when you need to view configuration and metadata for a single contact field including its type, position, and customer/agent requirements.

Input Parameters

integer
required
The unique identifier of the contact field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_EMAILTool to retrieve mailbox settings for the Freshdesk account. Use when you need to view email configuration settings such as threading options, requester creation settings, and agent conversation permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_EMAIL_CONFIGSTool to view details of a specific email configuration in Freshdesk. Use when you need to retrieve information about an email config including its associated product, group, and email addresses.

Input Parameters

integer
required
The unique identifier of the email configuration to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_GROUPTool to view details of a specific admin group in Freshdesk. Use when you need to retrieve information about a group including its members, escalation settings, and automatic assignment configuration.

Input Parameters

integer
required
The unique identifier of the group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_NOTIFICATIONSTool to view automatic BCC email addresses configured in Freshdesk. Use when you need to retrieve the list of email addresses that are automatically added as BCC to outgoing emails from the helpdesk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_PRODUCTSTool to retrieve detailed information about a specific product by ID. Use when you need to view a particular product’s details including name, description, primary email, and default status.

Input Parameters

integer
required
The unique identifier of the product to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_ROLESTool to view detailed information about a specific role by ID. Use when you need to retrieve a particular role’s name, description, default status, and agent type.

Input Parameters

integer
required
The unique identifier of the role to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_SETTINGSTool to retrieve helpdesk settings from Freshdesk. Use when you need to view language configuration including primary language, supported languages, portal languages, and help widget languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_SKILLTool to retrieve a specific skill from Freshdesk by ID. Use when you need to view detailed information about a particular skill including its name, rank, associated agents, and routing conditions.

Input Parameters

integer
required
The unique identifier of the skill to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_SOLUTION_CATEGORYTool to view a specific solution category by ID in Freshdesk. Use when you need to retrieve detailed information about a single solution category including its name, description, and visibility settings.

Input Parameters

integer
required
The unique identifier of the solution category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_SOLUTION_FOLDERTool to view a specific solution folder by ID in Freshdesk. Use when you need to retrieve detailed information about a solution folder including its name, description, hierarchy, and visibility settings.

Input Parameters

integer
required
The unique identifier of the solution folder to retrieve
string
Optional language code for translated version (e.g., ‘en’, ‘es’, ‘fr’). If specified, retrieves the folder in that language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_SOLUTIONSTool to view a specific solution article by ID in Freshdesk. Use when you need to retrieve detailed information about a single article including its content, metadata, SEO data, and engagement metrics.

Input Parameters

integer
required
The unique identifier of the solution article to retrieve
string
Optional language code for translated version (e.g., ‘fr’, ‘es’, ‘de’). If specified, retrieves the article in that language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_TICKETViews an existing ticket in Freshdesk. Ticket details are returned nested under response_data in the tool response.

Input Parameters

string
Comma-separated list of additional information to include in the response. Valid values: ‘stats’ (ticket timing statistics like first response time), ‘requester’ (full requester details), ‘company’ (company information). Example: ‘stats,requester,company’ to include all expansion fields.
integer
required
ID of the ticket to be viewed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_TICKET_FIELDTool to retrieve a single ticket field configuration from Freshdesk. Use when you need to view detailed information about a specific ticket field including its type, position, visibility settings, and validation requirements.

Input Parameters

integer
required
The unique identifier of the ticket field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRESHDESK_VIEW_TICKET_FORM_FIELDTool to retrieve a specific field from a ticket form in Freshdesk. Use when you need to view detailed configuration of a field including its type, position, visibility, and requirement settings.

Input Parameters

string
required
The ID of the ticket form
string
required
The ID of the field within the ticket form

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not