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-solutions | Type: Application | PCID required: Yes
freshdesk_solutions_create_solution_article
Create a solution article
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
folder_id | integer | Yes | — | ID of the parent folder |
agent_id | integer | No | — | ID of the agent author |
description | string | Yes | — | HTML content of the article |
seo_data | object | No | — | SEO metadata |
status | integer | Yes | — | Status: 1=Draft, 2=Published |
tags | string[] | No | — | Tags to associate |
title | string | Yes | — | Title of the article |
type | integer | No | — | Type: 1=Permanent, 2=Workaround |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "integer",
"description": "ID of the parent folder"
},
"agent_id": {
"type": "integer",
"description": "ID of the agent author"
},
"description": {
"type": "string",
"description": "HTML content of the article"
},
"seo_data": {
"type": "object",
"description": "SEO metadata",
"properties": {
"meta_title": {
"type": "string",
"description": "Meta Title"
},
"meta_description": {
"type": "string",
"description": "Meta Description"
}
}
},
"status": {
"type": "integer",
"description": "Status: 1=Draft, 2=Published"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to associate"
},
"title": {
"type": "string",
"description": "Title of the article"
},
"type": {
"type": "integer",
"description": "Type: 1=Permanent, 2=Workaround"
}
},
"required": [
"PCID",
"folder_id",
"description",
"status",
"title"
]
}
freshdesk_solutions_create_solution_category
Create a solution category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
description | string | No | — | The description value |
name | string | Yes | — | Name of the category |
visible_in_portals | integer[] | No | — | Portal IDs where this category should be visible |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"visible_in_portals": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Portal IDs where this category should be visible"
}
},
"required": [
"PCID",
"name"
]
}
freshdesk_solutions_create_solution_folder
Create a solution folder
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
category_id | integer | Yes | — | ID of the parent category |
company_ids | integer[] | No | — | Company IDs (required when visibility=4) |
description | string | No | — | The description value |
name | string | Yes | — | Name of the folder |
visibility | integer | Yes | — | Visibility: 1=All users, 2=Logged-in users, 3=Agents only, 4=Selected companies |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category_id": {
"type": "integer",
"description": "ID of the parent category"
},
"company_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Company IDs (required when visibility=4)"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "Name of the folder"
},
"visibility": {
"type": "integer",
"description": "Visibility: 1=All users, 2=Logged-in users, 3=Agents only, 4=Selected companies"
}
},
"required": [
"PCID",
"category_id",
"name",
"visibility"
]
}
freshdesk_solutions_create_solution_subfolder
Create a solution subfolder
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
folder_id | integer | Yes | — | ID of the parent folder |
description | string | No | — | Description of the subfolder |
name | string | Yes | — | Name of the subfolder |
visibility | integer | No | — | Visibility: 1=All users, 2=Logged in users, 3=Agents only, 4=Select companies |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "integer",
"description": "ID of the parent folder"
},
"description": {
"type": "string",
"description": "Description of the subfolder"
},
"name": {
"type": "string",
"description": "Name of the subfolder"
},
"visibility": {
"type": "integer",
"description": "Visibility: 1=All users, 2=Logged in users, 3=Agents only, 4=Select companies"
}
},
"required": [
"PCID",
"folder_id",
"name"
]
}
freshdesk_solutions_delete_solution_article
Delete a solution article
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution article to delete |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution article to delete"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_delete_solution_category
Delete a solution category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution category to delete |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution category to delete"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_delete_solution_folder
Delete a solution folder
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution folder to delete |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution folder to delete"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_get_solution_article
Get a solution article
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution article |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution article"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_get_solution_category
Get a solution category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution category |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution category"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_get_solution_folder
Get a solution folder
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution folder |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution folder"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_list_solution_articles
List solution articles in a folder
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
folder_id | integer | Yes | — | ID of the parent folder |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"folder_id": {
"type": "integer",
"description": "ID of the parent folder"
}
},
"required": [
"PCID",
"folder_id"
]
}
freshdesk_solutions_list_solution_categories
List all solution categories
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshdesk_solutions_list_solution_folders
List solution folders in a category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
category_id | integer | Yes | — | ID of the parent category |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category_id": {
"type": "integer",
"description": "ID of the parent category"
}
},
"required": [
"PCID",
"category_id"
]
}
freshdesk_solutions_search_solution_articles
Search solution articles
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
term | string | Yes | — | Search keyword or phrase |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"term": {
"type": "string",
"description": "Search keyword or phrase"
}
},
"required": [
"PCID",
"term"
]
}
freshdesk_solutions_update_solution_article
Update a solution article
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution article to update |
agent_id | integer | No | — | ID of the agent author |
description | string | No | — | HTML content of the article |
seo_data | object | No | — | SEO metadata |
status | integer | No | — | Status: 1=Draft, 2=Published |
tags | string[] | No | — | Tags to associate |
title | string | No | — | Title of the article |
type | integer | No | — | Type: 1=Permanent, 2=Workaround |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution article to update"
},
"agent_id": {
"type": "integer",
"description": "ID of the agent author"
},
"description": {
"type": "string",
"description": "HTML content of the article"
},
"seo_data": {
"type": "object",
"description": "SEO metadata",
"properties": {
"meta_title": {
"type": "string",
"description": "Meta Title"
},
"meta_description": {
"type": "string",
"description": "Meta Description"
}
}
},
"status": {
"type": "integer",
"description": "Status: 1=Draft, 2=Published"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to associate"
},
"title": {
"type": "string",
"description": "Title of the article"
},
"type": {
"type": "integer",
"description": "Type: 1=Permanent, 2=Workaround"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_update_solution_category
Update a solution category
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution category to update |
description | string | No | — | The description value |
name | string | No | — | Name of the category |
visible_in_portals | integer[] | No | — | Portal IDs where this category should be visible |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution category to update"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "Name of the category"
},
"visible_in_portals": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Portal IDs where this category should be visible"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_solutions_update_solution_folder
Update a solution folder
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | ID of the solution folder to update |
company_ids | integer[] | No | — | Company IDs (required when visibility=4) |
description | string | No | — | The description value |
name | string | No | — | Name of the folder |
visibility | integer | No | — | Visibility: 1=All users, 2=Logged-in users, 3=Agents only, 4=Selected companies |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the solution folder to update"
},
"company_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Company IDs (required when visibility=4)"
},
"description": {
"type": "string",
"description": "The description value"
},
"name": {
"type": "string",
"description": "Name of the folder"
},
"visibility": {
"type": "integer",
"description": "Visibility: 1=All users, 2=Logged-in users, 3=Agents only, 4=Selected companies"
}
},
"required": [
"PCID",
"id"
]
}
