Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /freshdesk-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
freshdesk_admin_create_agentCreate an agent
freshdesk_admin_create_automation_ruleCreate an automation rule
freshdesk_admin_create_email_mailboxCreate an email mailbox
freshdesk_admin_create_groupCreate a group
freshdesk_admin_create_skillCreate a skill
freshdesk_admin_create_slapolicyCreate an SLA policy
freshdesk_admin_delete_agentDelete an agent
freshdesk_admin_delete_automation_ruleDelete an automation rule
freshdesk_admin_delete_email_mailboxDelete an email mailbox
freshdesk_admin_delete_groupDelete a group
freshdesk_admin_delete_skillDelete a skill
freshdesk_admin_get_accountGet account details
freshdesk_admin_get_agentGet an agent
freshdesk_admin_get_automation_ruleGet an automation rule
freshdesk_admin_get_current_agentGet the currently authenticated agent
freshdesk_admin_get_email_mailboxGet an email mailbox
freshdesk_admin_get_groupGet a group
freshdesk_admin_get_helpdesk_settingsGet helpdesk settings
freshdesk_admin_get_jobGet job status
freshdesk_admin_get_roleGet a role
freshdesk_admin_get_skillGet a skill
freshdesk_admin_get_slapolicyGet an SLA policy
freshdesk_admin_list_agentsList all agents
freshdesk_admin_list_automation_rulesList automation rules
freshdesk_admin_list_business_hoursList all business hours
freshdesk_admin_list_email_configsList all email configurations
freshdesk_admin_list_email_mailboxesList email mailboxes
freshdesk_admin_list_groupsList all groups
freshdesk_admin_list_rolesList all roles
freshdesk_admin_list_scenario_automationsList scenario automations
freshdesk_admin_list_skillsList all skills
freshdesk_admin_list_slapoliciesList all SLA policies
freshdesk_admin_search_agentsAutocomplete search for agents
freshdesk_admin_update_agentUpdate an agent
freshdesk_admin_update_automation_ruleUpdate an automation rule
freshdesk_admin_update_email_mailboxUpdate an email mailbox
freshdesk_admin_update_groupUpdate a group
freshdesk_admin_update_skillUpdate a skill
freshdesk_admin_update_slapolicyUpdate an SLA policy

freshdesk_admin_create_agent

Create an agent Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail address of the agent
group_idsinteger[]NoGroup IDs the agent belongs to
job_titlestringNoJob title
languagestringNoLanguage of the agent
mobilestringNoMobile number
namestringNoFull name of the agent
occasionalbooleanNoWhether this is an occasional (day pass) agent
phonestringNoPhone number
role_idsinteger[]NoRole IDs assigned to the agent
signaturestringNoAgent’s email signature in HTML
skill_idsinteger[]NoSkill IDs assigned to the agent
ticket_scopeintegerYesTicket scope: 1=Global, 2=Group, 3=Restricted
time_zonestringNoTimezone of the agent

freshdesk_admin_create_automation_rule

Create an automation rule Parameters:
ParameterTypeRequiredDefaultDescription
automation_type_idintegerYesType of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications
actionsobject[]NoActions when rule triggers
activebooleanNoWhether the rule is active
conditionsobject[]NoConditions for the rule
descriptionstringNoDescription of the rule
eventsobject[]NoTrigger events
namestringYesName of the rule
performerobjectNoWho triggers the rule

freshdesk_admin_create_email_mailbox

Create an email mailbox Parameters:
ParameterTypeRequiredDefaultDescription
group_idintegerNoDefault group ID
namestringYesName of the mailbox
product_idintegerNoAssociated product ID
support_emailstringYesSupport email address

freshdesk_admin_create_group

Create a group Parameters:
ParameterTypeRequiredDefaultDescription
agent_idsinteger[]NoIDs of agents to add to the group
auto_ticket_assignintegerNoAuto assignment: 0=Disabled, 1=Round Robin
business_hour_idintegerNoBusiness hour schedule ID
descriptionstringNoThe description value
escalate_tointegerNoAgent ID to escalate to
namestringYesName of the group
unassigned_forstringNoTime duration for unassigned escalation

freshdesk_admin_create_skill

Create a skill Parameters:
ParameterTypeRequiredDefaultDescription
agentsobject[]NoAgents with this skill
conditionsobject[]NoMatch conditions
namestringYesName of the skill
rankintegerNoRank/priority of the skill

freshdesk_admin_create_slapolicy

Create an SLA policy Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoWhether the SLA policy is active
applicable_toobjectNoConditions for when this SLA applies
descriptionstringNoDescription of the SLA policy
escalationobjectNoEscalation settings
namestringYesName of the SLA policy
sla_targetobjectNoSLA targets for different priority levels

freshdesk_admin_delete_agent

Delete an agent Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the agent to delete

freshdesk_admin_delete_automation_rule

Delete an automation rule Parameters:
ParameterTypeRequiredDefaultDescription
automation_type_idintegerYesType of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications
idintegerYesID of the automation rule to delete

freshdesk_admin_delete_email_mailbox

Delete an email mailbox Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the email mailbox to delete

freshdesk_admin_delete_group

Delete a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the group to delete

freshdesk_admin_delete_skill

Delete a skill Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the skill to delete

freshdesk_admin_get_account

Get account details

freshdesk_admin_get_agent

Get an agent Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the agent

freshdesk_admin_get_automation_rule

Get an automation rule Parameters:
ParameterTypeRequiredDefaultDescription
automation_type_idintegerYesType of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications
idintegerYesID of the automation rule

freshdesk_admin_get_current_agent

Get the currently authenticated agent

freshdesk_admin_get_email_mailbox

Get an email mailbox Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the email mailbox

freshdesk_admin_get_group

Get a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the group

freshdesk_admin_get_helpdesk_settings

Get helpdesk settings

freshdesk_admin_get_job

Get job status Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of the background job

freshdesk_admin_get_role

Get a role Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the role

freshdesk_admin_get_skill

Get a skill Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the skill

freshdesk_admin_get_slapolicy

Get an SLA policy Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the SLA policy

freshdesk_admin_list_agents

List all agents Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoFilter by agent email address
mobilestringNoFilter by mobile number
phonestringNoFilter by phone number
statestringNoFilter by state: fulltime, occasional
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page (max 100)

freshdesk_admin_list_automation_rules

List automation rules Parameters:
ParameterTypeRequiredDefaultDescription
automation_type_idintegerYesType of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications
pageintegerNoPage number for pagination (starts at 1)
per_pageintegerNoNumber of results per page (max 100)

freshdesk_admin_list_business_hours

List all business hours

freshdesk_admin_list_email_configs

List all email configurations

freshdesk_admin_list_email_mailboxes

List email mailboxes

freshdesk_admin_list_groups

List all groups Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page (max 100)

freshdesk_admin_list_roles

List all roles

freshdesk_admin_list_scenario_automations

List scenario automations

freshdesk_admin_list_skills

List all skills

freshdesk_admin_list_slapolicies

List all SLA policies

freshdesk_admin_search_agents

Autocomplete search for agents Parameters:
ParameterTypeRequiredDefaultDescription
termstringYesSearch term to match against agent name or email

freshdesk_admin_update_agent

Update an agent Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the agent to update
emailstringNoEmail address
group_idsinteger[]NoGroup IDs to assign
job_titlestringNoJob title
languagestringNoLanguage preference
mobilestringNoMobile number
namestringNoName of the agent
occasionalbooleanNoWhether this is an occasional agent
phonestringNoPhone number
role_idsinteger[]NoRole IDs to assign
signaturestringNoHTML signature
ticket_scopeintegerNoTicket access scope: 1=Global, 2=Group, 3=Restricted
time_zonestringNoTimezone

freshdesk_admin_update_automation_rule

Update an automation rule Parameters:
ParameterTypeRequiredDefaultDescription
automation_type_idintegerYesType of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications
idintegerYesID of the automation rule to update
actionsobject[]NoActions when rule triggers
activebooleanNoWhether the rule is active
conditionsobject[]NoConditions for the rule
descriptionstringNoDescription of the rule
eventsobject[]NoTrigger events
namestringNoName of the rule
performerobjectNoWho triggers the rule

freshdesk_admin_update_email_mailbox

Update an email mailbox Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the email mailbox to update
group_idintegerNoDefault group ID
namestringNoName of the mailbox
product_idintegerNoAssociated product ID
support_emailstringNoSupport email address

freshdesk_admin_update_group

Update a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the group to update
agent_idsinteger[]NoAgent IDs
auto_ticket_assignintegerNoAuto assignment: 0=Disabled, 1=Round Robin
business_hour_idintegerNoBusiness hour schedule ID
descriptionstringNoThe description value
escalate_tointegerNoAgent ID to escalate to
namestringNoName of the group
unassigned_forstringNoTime duration for unassigned escalation

freshdesk_admin_update_skill

Update a skill Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the skill to update
agentsobject[]NoAgents with this skill
conditionsobject[]NoMatch conditions
namestringNoName of the skill
rankintegerNoRank/priority

freshdesk_admin_update_slapolicy

Update an SLA policy Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the SLA policy to update
activebooleanNoWhether the SLA policy is active
applicable_toobjectNoConditions for when this SLA applies
descriptionstringNoDescription of the SLA policy
escalationobjectNoEscalation settings
namestringNoName of the SLA policy
sla_targetobjectNoSLA targets for different priority levels