Skip to main content
Server path: /freshdesk-admin | Type: Application | PCID required: Yes

Tools


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_delete_agent

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

freshdesk_admin_delete_group

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

freshdesk_admin_get_agent

Get an agent Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the agent

freshdesk_admin_get_current_agent

Get the currently authenticated agent

freshdesk_admin_get_group

Get a group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the group

freshdesk_admin_get_role

Get a role Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the role

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_business_hours

List all business hours

freshdesk_admin_list_email_configs

List all email configurations

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_slapolicies

List all SLA policies

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_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