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
freshdesk_admin_create_agent
Create an agent
Parameters:
Parameter Type Required Default Description emailstring Yes — Email address of the agent group_idsinteger[] No — Group IDs the agent belongs to job_titlestring No — Job title languagestring No — Language of the agent mobilestring No — Mobile number namestring No — Full name of the agent occasionalboolean No — Whether this is an occasional (day pass) agent phonestring No — Phone number role_idsinteger[] No — Role IDs assigned to the agent signaturestring No — Agent’s email signature in HTML skill_idsinteger[] No — Skill IDs assigned to the agent ticket_scopeinteger Yes — Ticket scope: 1=Global, 2=Group, 3=Restricted time_zonestring No — Timezone of the agent
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"email" : {
"type" : "string" ,
"description" : "Email address of the agent"
},
"group_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Group IDs the agent belongs to"
},
"job_title" : {
"type" : "string" ,
"description" : "Job title"
},
"language" : {
"type" : "string" ,
"description" : "Language of the agent"
},
"mobile" : {
"type" : "string" ,
"description" : "Mobile number"
},
"name" : {
"type" : "string" ,
"description" : "Full name of the agent"
},
"occasional" : {
"type" : "boolean" ,
"description" : "Whether this is an occasional (day pass) agent"
},
"phone" : {
"type" : "string" ,
"description" : "Phone number"
},
"role_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Role IDs assigned to the agent"
},
"signature" : {
"type" : "string" ,
"description" : "Agent's email signature in HTML"
},
"skill_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Skill IDs assigned to the agent"
},
"ticket_scope" : {
"type" : "integer" ,
"description" : "Ticket scope: 1=Global, 2=Group, 3=Restricted"
},
"time_zone" : {
"type" : "string" ,
"description" : "Timezone of the agent"
}
},
"required" : [
"PCID" ,
"email" ,
"ticket_scope"
]
}
freshdesk_admin_create_automation_rule
Create an automation rule
Parameters:
Parameter Type Required Default Description automation_type_idinteger Yes — Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications actionsobject[] No — Actions when rule triggers activeboolean No — Whether the rule is active conditionsobject[] No — Conditions for the rule descriptionstring No — Description of the rule eventsobject[] No — Trigger events namestring Yes — Name of the rule performerobject No — Who triggers the rule
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"automation_type_id" : {
"type" : "integer" ,
"description" : "Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications" ,
"enum" : [
1 ,
2 ,
3 ,
4
]
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Actions when rule triggers"
},
"active" : {
"type" : "boolean" ,
"description" : "Whether the rule is active"
},
"conditions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Conditions for the rule"
},
"description" : {
"type" : "string" ,
"description" : "Description of the rule"
},
"events" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Trigger events"
},
"name" : {
"type" : "string" ,
"description" : "Name of the rule"
},
"performer" : {
"type" : "object" ,
"description" : "Who triggers the rule"
}
},
"required" : [
"PCID" ,
"automation_type_id" ,
"name"
]
}
freshdesk_admin_create_email_mailbox
Create an email mailbox
Parameters:
Parameter Type Required Default Description group_idinteger No — Default group ID namestring Yes — Name of the mailbox product_idinteger No — Associated product ID support_emailstring Yes — Support email address
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"group_id" : {
"type" : "integer" ,
"description" : "Default group ID"
},
"name" : {
"type" : "string" ,
"description" : "Name of the mailbox"
},
"product_id" : {
"type" : "integer" ,
"description" : "Associated product ID"
},
"support_email" : {
"type" : "string" ,
"description" : "Support email address"
}
},
"required" : [
"PCID" ,
"name" ,
"support_email"
]
}
freshdesk_admin_create_group
Create a group
Parameters:
Parameter Type Required Default Description agent_idsinteger[] No — IDs of agents to add to the group auto_ticket_assigninteger No — Auto assignment: 0=Disabled, 1=Round Robin business_hour_idinteger No — Business hour schedule ID descriptionstring No — The description value escalate_tointeger No — Agent ID to escalate to namestring Yes — Name of the group unassigned_forstring No — Time duration for unassigned escalation
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"agent_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "IDs of agents to add to the group"
},
"auto_ticket_assign" : {
"type" : "integer" ,
"description" : "Auto assignment: 0=Disabled, 1=Round Robin"
},
"business_hour_id" : {
"type" : "integer" ,
"description" : "Business hour schedule ID"
},
"description" : {
"type" : "string" ,
"description" : "The description value"
},
"escalate_to" : {
"type" : "integer" ,
"description" : "Agent ID to escalate to"
},
"name" : {
"type" : "string" ,
"description" : "Name of the group"
},
"unassigned_for" : {
"type" : "string" ,
"description" : "Time duration for unassigned escalation"
}
},
"required" : [
"PCID" ,
"name"
]
}
freshdesk_admin_create_skill
Create a skill
Parameters:
Parameter Type Required Default Description agentsobject[] No — Agents with this skill conditionsobject[] No — Match conditions namestring Yes — Name of the skill rankinteger No — Rank/priority of the skill
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"agents" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Agents with this skill"
},
"conditions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Match conditions"
},
"name" : {
"type" : "string" ,
"description" : "Name of the skill"
},
"rank" : {
"type" : "integer" ,
"description" : "Rank/priority of the skill"
}
},
"required" : [
"PCID" ,
"name"
]
}
freshdesk_admin_create_slapolicy
Create an SLA policy
Parameters:
Parameter Type Required Default Description activeboolean No — Whether the SLA policy is active applicable_toobject No — Conditions for when this SLA applies descriptionstring No — Description of the SLA policy escalationobject No — Escalation settings namestring Yes — Name of the SLA policy sla_targetobject No — SLA targets for different priority levels
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"active" : {
"type" : "boolean" ,
"description" : "Whether the SLA policy is active"
},
"applicable_to" : {
"type" : "object" ,
"description" : "Conditions for when this SLA applies"
},
"description" : {
"type" : "string" ,
"description" : "Description of the SLA policy"
},
"escalation" : {
"type" : "object" ,
"description" : "Escalation settings"
},
"name" : {
"type" : "string" ,
"description" : "Name of the SLA policy"
},
"sla_target" : {
"type" : "object" ,
"description" : "SLA targets for different priority levels"
}
},
"required" : [
"PCID" ,
"name"
]
}
freshdesk_admin_delete_agent
Delete an agent
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the agent to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the agent to delete"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_delete_automation_rule
Delete an automation rule
Parameters:
Parameter Type Required Default Description automation_type_idinteger Yes — Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications idinteger Yes — ID of the automation rule to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"automation_type_id" : {
"type" : "integer" ,
"description" : "Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications" ,
"enum" : [
1 ,
2 ,
3 ,
4
]
},
"id" : {
"type" : "integer" ,
"description" : "ID of the automation rule to delete"
}
},
"required" : [
"PCID" ,
"automation_type_id" ,
"id"
]
}
freshdesk_admin_delete_email_mailbox
Delete an email mailbox
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the email mailbox to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the email mailbox to delete"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_delete_group
Delete a group
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the group to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the group to delete"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_delete_skill
Delete a skill
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the skill to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the skill to delete"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_account
Get account details
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_get_agent
Get an agent
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the agent
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the agent"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_automation_rule
Get an automation rule
Parameters:
Parameter Type Required Default Description automation_type_idinteger Yes — Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications idinteger Yes — ID of the automation rule
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"automation_type_id" : {
"type" : "integer" ,
"description" : "Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications" ,
"enum" : [
1 ,
2 ,
3 ,
4
]
},
"id" : {
"type" : "integer" ,
"description" : "ID of the automation rule"
}
},
"required" : [
"PCID" ,
"automation_type_id" ,
"id"
]
}
freshdesk_admin_get_current_agent
Get the currently authenticated agent
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_get_email_mailbox
Get an email mailbox
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the email mailbox
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the email mailbox"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_group
Get a group
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the group
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the group"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_helpdesk_settings
Get helpdesk settings
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_get_job
Get job status
Parameters:
Parameter Type Required Default Description idstring Yes — ID of the background job
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "ID of the background job"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_role
Get a role
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the role
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the role"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_skill
Get a skill
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the skill
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the skill"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_get_slapolicy
Get an SLA policy
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the SLA policy
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the SLA policy"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_list_agents
List all agents
Parameters:
Parameter Type Required Default Description emailstring No — Filter by agent email address mobilestring No — Filter by mobile number phonestring No — Filter by phone number statestring No — Filter by state: fulltime, occasional pageinteger No — Page number for pagination per_pageinteger No — Number of results per page (max 100)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"email" : {
"type" : "string" ,
"description" : "Filter by agent email address"
},
"mobile" : {
"type" : "string" ,
"description" : "Filter by mobile number"
},
"phone" : {
"type" : "string" ,
"description" : "Filter by phone number"
},
"state" : {
"type" : "string" ,
"description" : "Filter by state: fulltime, occasional"
},
"page" : {
"type" : "integer" ,
"description" : "Page number for pagination"
},
"per_page" : {
"type" : "integer" ,
"description" : "Number of results per page (max 100)"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_automation_rules
List automation rules
Parameters:
Parameter Type Required Default Description automation_type_idinteger Yes — Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications pageinteger No — Page number for pagination (starts at 1) per_pageinteger No — Number of results per page (max 100)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"automation_type_id" : {
"type" : "integer" ,
"description" : "Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications" ,
"enum" : [
1 ,
2 ,
3 ,
4
]
},
"page" : {
"type" : "integer" ,
"description" : "Page number for pagination (starts at 1)"
},
"per_page" : {
"type" : "integer" ,
"description" : "Number of results per page (max 100)"
}
},
"required" : [
"PCID" ,
"automation_type_id"
]
}
freshdesk_admin_list_business_hours
List all business hours
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_email_configs
List all email configurations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_email_mailboxes
List email mailboxes
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_groups
List all groups
Parameters:
Parameter Type Required Default Description pageinteger No — Page number for pagination per_pageinteger No — Number of results per page (max 100)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"page" : {
"type" : "integer" ,
"description" : "Page number for pagination"
},
"per_page" : {
"type" : "integer" ,
"description" : "Number of results per page (max 100)"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_roles
List all roles
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_scenario_automations
List scenario automations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_skills
List all skills
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_list_slapolicies
List all SLA policies
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
freshdesk_admin_search_agents
Autocomplete search for agents
Parameters:
Parameter Type Required Default Description termstring Yes — Search term to match against agent name or email
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"term" : {
"type" : "string" ,
"description" : "Search term to match against agent name or email"
}
},
"required" : [
"PCID" ,
"term"
]
}
freshdesk_admin_update_agent
Update an agent
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the agent to update emailstring No — Email address group_idsinteger[] No — Group IDs to assign job_titlestring No — Job title languagestring No — Language preference mobilestring No — Mobile number namestring No — Name of the agent occasionalboolean No — Whether this is an occasional agent phonestring No — Phone number role_idsinteger[] No — Role IDs to assign signaturestring No — HTML signature ticket_scopeinteger No — Ticket access scope: 1=Global, 2=Group, 3=Restricted time_zonestring No — Timezone
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the agent to update"
},
"email" : {
"type" : "string" ,
"description" : "Email address"
},
"group_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Group IDs to assign"
},
"job_title" : {
"type" : "string" ,
"description" : "Job title"
},
"language" : {
"type" : "string" ,
"description" : "Language preference"
},
"mobile" : {
"type" : "string" ,
"description" : "Mobile number"
},
"name" : {
"type" : "string" ,
"description" : "Name of the agent"
},
"occasional" : {
"type" : "boolean" ,
"description" : "Whether this is an occasional agent"
},
"phone" : {
"type" : "string" ,
"description" : "Phone number"
},
"role_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Role IDs to assign"
},
"signature" : {
"type" : "string" ,
"description" : "HTML signature"
},
"ticket_scope" : {
"type" : "integer" ,
"description" : "Ticket access scope: 1=Global, 2=Group, 3=Restricted"
},
"time_zone" : {
"type" : "string" ,
"description" : "Timezone"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_update_automation_rule
Update an automation rule
Parameters:
Parameter Type Required Default Description automation_type_idinteger Yes — Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications idinteger Yes — ID of the automation rule to update actionsobject[] No — Actions when rule triggers activeboolean No — Whether the rule is active conditionsobject[] No — Conditions for the rule descriptionstring No — Description of the rule eventsobject[] No — Trigger events namestring No — Name of the rule performerobject No — Who triggers the rule
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"automation_type_id" : {
"type" : "integer" ,
"description" : "Type of automation: 1=Ticket Creation, 2=Time Triggers, 3=Ticket Update, 4=Email Notifications" ,
"enum" : [
1 ,
2 ,
3 ,
4
]
},
"id" : {
"type" : "integer" ,
"description" : "ID of the automation rule to update"
},
"actions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Actions when rule triggers"
},
"active" : {
"type" : "boolean" ,
"description" : "Whether the rule is active"
},
"conditions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Conditions for the rule"
},
"description" : {
"type" : "string" ,
"description" : "Description of the rule"
},
"events" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Trigger events"
},
"name" : {
"type" : "string" ,
"description" : "Name of the rule"
},
"performer" : {
"type" : "object" ,
"description" : "Who triggers the rule"
}
},
"required" : [
"PCID" ,
"automation_type_id" ,
"id"
]
}
freshdesk_admin_update_email_mailbox
Update an email mailbox
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the email mailbox to update group_idinteger No — Default group ID namestring No — Name of the mailbox product_idinteger No — Associated product ID support_emailstring No — Support email address
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the email mailbox to update"
},
"group_id" : {
"type" : "integer" ,
"description" : "Default group ID"
},
"name" : {
"type" : "string" ,
"description" : "Name of the mailbox"
},
"product_id" : {
"type" : "integer" ,
"description" : "Associated product ID"
},
"support_email" : {
"type" : "string" ,
"description" : "Support email address"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_update_group
Update a group
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the group to update agent_idsinteger[] No — Agent IDs auto_ticket_assigninteger No — Auto assignment: 0=Disabled, 1=Round Robin business_hour_idinteger No — Business hour schedule ID descriptionstring No — The description value escalate_tointeger No — Agent ID to escalate to namestring No — Name of the group unassigned_forstring No — Time duration for unassigned escalation
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the group to update"
},
"agent_ids" : {
"type" : "array" ,
"items" : {
"type" : "integer"
},
"description" : "Agent IDs"
},
"auto_ticket_assign" : {
"type" : "integer" ,
"description" : "Auto assignment: 0=Disabled, 1=Round Robin"
},
"business_hour_id" : {
"type" : "integer" ,
"description" : "Business hour schedule ID"
},
"description" : {
"type" : "string" ,
"description" : "The description value"
},
"escalate_to" : {
"type" : "integer" ,
"description" : "Agent ID to escalate to"
},
"name" : {
"type" : "string" ,
"description" : "Name of the group"
},
"unassigned_for" : {
"type" : "string" ,
"description" : "Time duration for unassigned escalation"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_update_skill
Update a skill
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the skill to update agentsobject[] No — Agents with this skill conditionsobject[] No — Match conditions namestring No — Name of the skill rankinteger No — Rank/priority
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the skill to update"
},
"agents" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Agents with this skill"
},
"conditions" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Match conditions"
},
"name" : {
"type" : "string" ,
"description" : "Name of the skill"
},
"rank" : {
"type" : "integer" ,
"description" : "Rank/priority"
}
},
"required" : [
"PCID" ,
"id"
]
}
freshdesk_admin_update_slapolicy
Update an SLA policy
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the SLA policy to update activeboolean No — Whether the SLA policy is active applicable_toobject No — Conditions for when this SLA applies descriptionstring No — Description of the SLA policy escalationobject No — Escalation settings namestring No — Name of the SLA policy sla_targetobject No — SLA targets for different priority levels
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "integer" ,
"description" : "ID of the SLA policy to update"
},
"active" : {
"type" : "boolean" ,
"description" : "Whether the SLA policy is active"
},
"applicable_to" : {
"type" : "object" ,
"description" : "Conditions for when this SLA applies"
},
"description" : {
"type" : "string" ,
"description" : "Description of the SLA policy"
},
"escalation" : {
"type" : "object" ,
"description" : "Escalation settings"
},
"name" : {
"type" : "string" ,
"description" : "Name of the SLA policy"
},
"sla_target" : {
"type" : "object" ,
"description" : "SLA targets for different priority levels"
}
},
"required" : [
"PCID" ,
"id"
]
}