/freshdesk-admin | Type: Application | PCID required: Yes
Tools
freshdesk_admin_create_agent
Create an agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | Yes | — | Email address of the agent |
group_ids | integer[] | No | — | Group IDs the agent belongs to |
job_title | string | No | — | Job title |
language | string | No | — | Language of the agent |
mobile | string | No | — | Mobile number |
name | string | No | — | Full name of the agent |
occasional | boolean | No | — | Whether this is an occasional (day pass) agent |
phone | string | No | — | Phone number |
role_ids | integer[] | No | — | Role IDs assigned to the agent |
signature | string | No | — | Agent’s email signature in HTML |
skill_ids | integer[] | No | — | Skill IDs assigned to the agent |
ticket_scope | integer | Yes | — | Ticket scope: 1=Global, 2=Group, 3=Restricted |
time_zone | string | No | — | Timezone of the agent |
freshdesk_admin_create_automation_rule
Create an automation rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_type_id | integer | Yes | — | Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications |
actions | object[] | No | — | Actions when rule triggers |
active | boolean | No | — | Whether the rule is active |
conditions | object[] | No | — | Conditions for the rule |
description | string | No | — | Description of the rule |
events | object[] | No | — | Trigger events |
name | string | Yes | — | Name of the rule |
performer | object | No | — | Who triggers the rule |
freshdesk_admin_create_email_mailbox
Create an email mailbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | integer | No | — | Default group ID |
name | string | Yes | — | Name of the mailbox |
product_id | integer | No | — | Associated product ID |
support_email | string | Yes | — | Support email address |
freshdesk_admin_create_group
Create a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agent_ids | integer[] | No | — | IDs of agents to add to the group |
auto_ticket_assign | integer | No | — | Auto assignment: 0=Disabled, 1=Round Robin |
business_hour_id | integer | No | — | Business hour schedule ID |
description | string | No | — | The description value |
escalate_to | integer | No | — | Agent ID to escalate to |
name | string | Yes | — | Name of the group |
unassigned_for | string | No | — | Time duration for unassigned escalation |
freshdesk_admin_create_skill
Create a skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
agents | object[] | No | — | Agents with this skill |
conditions | object[] | No | — | Match conditions |
name | string | Yes | — | Name of the skill |
rank | integer | No | — | Rank/priority of the skill |
freshdesk_admin_create_slapolicy
Create an SLA policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | Whether the SLA policy is active |
applicable_to | object | No | — | Conditions for when this SLA applies |
description | string | No | — | Description of the SLA policy |
escalation | object | No | — | Escalation settings |
name | string | Yes | — | Name of the SLA policy |
sla_target | object | No | — | SLA targets for different priority levels |
freshdesk_admin_delete_agent
Delete an agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the agent to delete |
freshdesk_admin_delete_automation_rule
Delete an automation rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_type_id | integer | Yes | — | Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications |
id | integer | Yes | — | ID of the automation rule to delete |
freshdesk_admin_delete_email_mailbox
Delete an email mailbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the email mailbox to delete |
freshdesk_admin_delete_group
Delete a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the group to delete |
freshdesk_admin_delete_skill
Delete a skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the skill to delete |
freshdesk_admin_get_account
Get account detailsfreshdesk_admin_get_agent
Get an agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the agent |
freshdesk_admin_get_automation_rule
Get an automation rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_type_id | integer | Yes | — | Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications |
id | integer | Yes | — | ID of the automation rule |
freshdesk_admin_get_current_agent
Get the currently authenticated agentfreshdesk_admin_get_email_mailbox
Get an email mailbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the email mailbox |
freshdesk_admin_get_group
Get a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the group |
freshdesk_admin_get_helpdesk_settings
Get helpdesk settingsfreshdesk_admin_get_job
Get job status Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | ID of the background job |
freshdesk_admin_get_role
Get a role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the role |
freshdesk_admin_get_skill
Get a skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the skill |
freshdesk_admin_get_slapolicy
Get an SLA policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the SLA policy |
freshdesk_admin_list_agents
List all agents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Filter by agent email address |
mobile | string | No | — | Filter by mobile number |
phone | string | No | — | Filter by phone number |
state | string | No | — | Filter by state: fulltime, occasional |
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page (max 100) |
freshdesk_admin_list_automation_rules
List automation rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_type_id | integer | Yes | — | Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications |
page | integer | No | — | Page number for pagination (starts at 1) |
per_page | integer | No | — | Number of results per page (max 100) |
freshdesk_admin_list_business_hours
List all business hoursfreshdesk_admin_list_email_configs
List all email configurationsfreshdesk_admin_list_email_mailboxes
List email mailboxesfreshdesk_admin_list_groups
List all groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page (max 100) |
freshdesk_admin_list_roles
List all rolesfreshdesk_admin_list_scenario_automations
List scenario automationsfreshdesk_admin_list_skills
List all skillsfreshdesk_admin_list_slapolicies
List all SLA policiesfreshdesk_admin_search_agents
Autocomplete search for agents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
term | string | Yes | — | Search term to match against agent name or email |
freshdesk_admin_update_agent
Update an agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the agent to update |
email | string | No | — | Email address |
group_ids | integer[] | No | — | Group IDs to assign |
job_title | string | No | — | Job title |
language | string | No | — | Language preference |
mobile | string | No | — | Mobile number |
name | string | No | — | Name of the agent |
occasional | boolean | No | — | Whether this is an occasional agent |
phone | string | No | — | Phone number |
role_ids | integer[] | No | — | Role IDs to assign |
signature | string | No | — | HTML signature |
ticket_scope | integer | No | — | Ticket access scope: 1=Global, 2=Group, 3=Restricted |
time_zone | string | No | — | Timezone |
freshdesk_admin_update_automation_rule
Update an automation rule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
automation_type_id | integer | Yes | — | Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications |
id | integer | Yes | — | ID of the automation rule to update |
actions | object[] | No | — | Actions when rule triggers |
active | boolean | No | — | Whether the rule is active |
conditions | object[] | No | — | Conditions for the rule |
description | string | No | — | Description of the rule |
events | object[] | No | — | Trigger events |
name | string | No | — | Name of the rule |
performer | object | No | — | Who triggers the rule |
freshdesk_admin_update_email_mailbox
Update an email mailbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the email mailbox to update |
group_id | integer | No | — | Default group ID |
name | string | No | — | Name of the mailbox |
product_id | integer | No | — | Associated product ID |
support_email | string | No | — | Support email address |
freshdesk_admin_update_group
Update a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the group to update |
agent_ids | integer[] | No | — | Agent IDs |
auto_ticket_assign | integer | No | — | Auto assignment: 0=Disabled, 1=Round Robin |
business_hour_id | integer | No | — | Business hour schedule ID |
description | string | No | — | The description value |
escalate_to | integer | No | — | Agent ID to escalate to |
name | string | No | — | Name of the group |
unassigned_for | string | No | — | Time duration for unassigned escalation |
freshdesk_admin_update_skill
Update a skill Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the skill to update |
agents | object[] | No | — | Agents with this skill |
conditions | object[] | No | — | Match conditions |
name | string | No | — | Name of the skill |
rank | integer | No | — | Rank/priority |
freshdesk_admin_update_slapolicy
Update an SLA policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the SLA policy to update |
active | boolean | No | — | Whether the SLA policy is active |
applicable_to | object | No | — | Conditions for when this SLA applies |
description | string | No | — | Description of the SLA policy |
escalation | object | No | — | Escalation settings |
name | string | No | — | Name of the SLA policy |
sla_target | object | No | — | SLA targets for different priority levels |

