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-support | Type: Application | PCID required: Yesfreshdesk_support_create_canned_response Create a canned response
Parameters: Parameter Type Required Default Description contentstring Yes — HTML content of the response folder_idinteger Yes — ID of the folder to place the response in titlestring Yes — Title of the canned response
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "content" : { "type" : "string" , "description" : "HTML content of the response" }, "folder_id" : { "type" : "integer" , "description" : "ID of the folder to place the response in" }, "title" : { "type" : "string" , "description" : "Title of the canned response" } }, "required" : [ "PCID" , "content" , "folder_id" , "title" ] }
Create a comment
Parameters: Parameter Type Required Default Description topic_idinteger Yes — ID of the topic to comment on attachmentsstring[] No — Attachments for the comment bodystring Yes — HTML content of the comment
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "topic_id" : { "type" : "integer" , "description" : "ID of the topic to comment on" }, "attachments" : { "type" : "array" , "items" : { "type" : "string" }, "description" : "Attachments for the comment" }, "body" : { "type" : "string" , "description" : "HTML content of the comment" } }, "required" : [ "PCID" , "topic_id" , "body" ] }
freshdesk_support_create_discussion_category Create a discussion category
Parameters: Parameter Type Required Default Description descriptionstring No — Description of the category namestring Yes — Name of the category
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "description" : { "type" : "string" , "description" : "Description of the category" }, "name" : { "type" : "string" , "description" : "Name of the category" } }, "required" : [ "PCID" , "name" ] }
freshdesk_support_create_forum Create a forum
Parameters: Parameter Type Required Default Description category_idinteger Yes — ID of the parent discussion category descriptionstring No — Description of the forum forum_typeinteger Yes — Type: 1=How To, 2=Ideas, 3=Problems, 4=Announcements forum_visibilityinteger No — Visibility: 1=All, 2=Logged in, 3=Agents, 4=Select companies namestring Yes — Name of the forum
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "category_id" : { "type" : "integer" , "description" : "ID of the parent discussion category" }, "description" : { "type" : "string" , "description" : "Description of the forum" }, "forum_type" : { "type" : "integer" , "description" : "Type: 1=How To, 2=Ideas, 3=Problems, 4=Announcements" }, "forum_visibility" : { "type" : "integer" , "description" : "Visibility: 1=All, 2=Logged in, 3=Agents, 4=Select companies" }, "name" : { "type" : "string" , "description" : "Name of the forum" } }, "required" : [ "PCID" , "category_id" , "forum_type" , "name" ] }
freshdesk_support_create_product Create a product
Parameters: Parameter Type Required Default Description descriptionstring No — The description value namestring Yes — Name of the product primary_emailstring No — Primary support email
{ "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 product" }, "primary_email" : { "type" : "string" , "description" : "Primary support email" } }, "required" : [ "PCID" , "name" ] }
freshdesk_support_create_satisfaction_rating Create a satisfaction rating
Parameters: Parameter Type Required Default Description ticket_idinteger Yes — ID of the ticket to rate feedbackstring No — Optional feedback text ratinginteger Yes — Rating value (depends on survey scale configured)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "ticket_id" : { "type" : "integer" , "description" : "ID of the ticket to rate" }, "feedback" : { "type" : "string" , "description" : "Optional feedback text" }, "rating" : { "type" : "integer" , "description" : "Rating value (depends on survey scale configured)" } }, "required" : [ "PCID" , "ticket_id" , "rating" ] }
freshdesk_support_create_time_entry Create a time entry for a ticket
Parameters: Parameter Type Required Default Description ticket_idinteger Yes — ID of the ticket agent_idinteger No — ID of the agent (defaults to current agent) billableboolean No — Whether billable executed_atstring No — When the work was performed notestring No — Note about the work time_spentstring Yes — Time spent in hh:mm format (e.g., ‘01:30’)
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "ticket_id" : { "type" : "integer" , "description" : "ID of the ticket" }, "agent_id" : { "type" : "integer" , "description" : "ID of the agent (defaults to current agent)" }, "billable" : { "type" : "boolean" , "description" : "Whether billable" }, "executed_at" : { "type" : "string" , "description" : "When the work was performed" }, "note" : { "type" : "string" , "description" : "Note about the work" }, "time_spent" : { "type" : "string" , "description" : "Time spent in hh:mm format (e.g., '01:30')" } }, "required" : [ "PCID" , "ticket_id" , "time_spent" ] }
freshdesk_support_create_topic Create a topic
Parameters: Parameter Type Required Default Description forum_idinteger Yes — ID of the parent forum lockedboolean No — Whether to lock the topic messagestring Yes — HTML content of the topic body stickyboolean No — Whether to pin the topic titlestring Yes — Title of the topic
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "forum_id" : { "type" : "integer" , "description" : "ID of the parent forum" }, "locked" : { "type" : "boolean" , "description" : "Whether to lock the topic" }, "message" : { "type" : "string" , "description" : "HTML content of the topic body" }, "sticky" : { "type" : "boolean" , "description" : "Whether to pin the topic" }, "title" : { "type" : "string" , "description" : "Title of the topic" } }, "required" : [ "PCID" , "forum_id" , "message" , "title" ] }
Delete a comment
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the comment to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the comment to delete" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_delete_discussion_category Delete a discussion category
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the discussion category to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the discussion category to delete" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_delete_forum Delete a forum
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the forum to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the forum to delete" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_delete_product Delete a product
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the product to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the product to delete" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_delete_time_entry Delete a time entry
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the time entry to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the time entry to delete" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_delete_topic Delete a topic
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the topic to delete
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the topic to delete" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_get_canned_response Get a canned response
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the canned response
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the canned response" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_get_canned_response_folder Get a canned response folder
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the canned response folder
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the canned response folder" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_get_discussion_category Get a discussion category
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the discussion category
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the discussion category" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_get_forum Get a forum
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the forum
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the forum" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_get_product Get a product
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the product
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the product" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_get_topic Get a topic
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the topic
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the topic" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_list_canned_response_folders List all canned response folders
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
freshdesk_support_list_canned_responses_in_folder List canned responses in a folder
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the canned response folder
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the canned response folder" } }, "required" : [ "PCID" , "id" ] }
List comments on a topic
Parameters: Parameter Type Required Default Description topic_idinteger Yes — ID of the topic
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "topic_id" : { "type" : "integer" , "description" : "ID of the topic" } }, "required" : [ "PCID" , "topic_id" ] }
freshdesk_support_list_discussion_categories List discussion categories
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
freshdesk_support_list_forums List forums in a category
Parameters: Parameter Type Required Default Description category_idinteger Yes — ID of the discussion category
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "category_id" : { "type" : "integer" , "description" : "ID of the discussion category" } }, "required" : [ "PCID" , "category_id" ] }
freshdesk_support_list_products List all products
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_support_list_satisfaction_ratings List satisfaction ratings
Parameters: Parameter Type Required Default Description created_sincestring No — Return ratings created since this date-time (ISO 8601) 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" }, "created_since" : { "type" : "string" , "description" : "Return ratings created since this date-time (ISO 8601)" }, "page" : { "type" : "integer" , "description" : "Page number for pagination" }, "per_page" : { "type" : "integer" , "description" : "Number of results per page (max 100)" } }, "required" : [ "PCID" ] }
freshdesk_support_list_surveys List CSAT surveys
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
freshdesk_support_list_ticket_time_entries List time entries for a ticket
Parameters: Parameter Type Required Default Description ticket_idinteger Yes — ID of the ticket
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "ticket_id" : { "type" : "integer" , "description" : "ID of the ticket" } }, "required" : [ "PCID" , "ticket_id" ] }
freshdesk_support_list_time_entries List all time entries
Parameters: Parameter Type Required Default Description company_idinteger No — Filter by company ID agent_idinteger No — Filter by agent ID executed_beforestring No — Filter time entries executed before this date (ISO 8601) executed_afterstring No — Filter time entries executed after this date (ISO 8601) billableboolean No — Filter by billable status (true or false) 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" }, "company_id" : { "type" : "integer" , "description" : "Filter by company ID" }, "agent_id" : { "type" : "integer" , "description" : "Filter by agent ID" }, "executed_before" : { "type" : "string" , "description" : "Filter time entries executed before this date (ISO 8601)" }, "executed_after" : { "type" : "string" , "description" : "Filter time entries executed after this date (ISO 8601)" }, "billable" : { "type" : "boolean" , "description" : "Filter by billable status (true or false)" }, "page" : { "type" : "integer" , "description" : "Page number for pagination" }, "per_page" : { "type" : "integer" , "description" : "Number of results per page (max 100)" } }, "required" : [ "PCID" ] }
freshdesk_support_list_topics List topics in a forum
Parameters: Parameter Type Required Default Description forum_idinteger Yes — ID of the forum
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "forum_id" : { "type" : "integer" , "description" : "ID of the forum" } }, "required" : [ "PCID" , "forum_id" ] }
freshdesk_support_update_canned_response Update a canned response
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the canned response to update contentstring No — HTML content of the response folder_idinteger No — ID of the folder to place the response in titlestring No — Title of the canned response
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the canned response to update" }, "content" : { "type" : "string" , "description" : "HTML content of the response" }, "folder_id" : { "type" : "integer" , "description" : "ID of the folder to place the response in" }, "title" : { "type" : "string" , "description" : "Title of the canned response" } }, "required" : [ "PCID" , "id" ] }
Update a comment
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the comment to update attachmentsstring[] No — Attachments for the comment bodystring No — HTML content of the comment
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the comment to update" }, "attachments" : { "type" : "array" , "items" : { "type" : "string" }, "description" : "Attachments for the comment" }, "body" : { "type" : "string" , "description" : "HTML content of the comment" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_update_discussion_category Update a discussion category
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the discussion category to update descriptionstring No — Description of the category namestring No — Name of the category
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the discussion category to update" }, "description" : { "type" : "string" , "description" : "Description of the category" }, "name" : { "type" : "string" , "description" : "Name of the category" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_update_forum Update a forum
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the forum to update descriptionstring No — Description of the forum forum_typeinteger No — Type: 1=How To, 2=Ideas, 3=Problems, 4=Announcements forum_visibilityinteger No — Visibility: 1=All, 2=Logged in, 3=Agents, 4=Select companies namestring No — Name of the forum
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the forum to update" }, "description" : { "type" : "string" , "description" : "Description of the forum" }, "forum_type" : { "type" : "integer" , "description" : "Type: 1=How To, 2=Ideas, 3=Problems, 4=Announcements" }, "forum_visibility" : { "type" : "integer" , "description" : "Visibility: 1=All, 2=Logged in, 3=Agents, 4=Select companies" }, "name" : { "type" : "string" , "description" : "Name of the forum" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_update_product Update a product
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the product to update descriptionstring No — The description value namestring No — Name of the product primary_emailstring No — Primary support email
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the product to update" }, "description" : { "type" : "string" , "description" : "The description value" }, "name" : { "type" : "string" , "description" : "Name of the product" }, "primary_email" : { "type" : "string" , "description" : "Primary support email" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_update_time_entry Update a time entry
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the time entry to update agent_idinteger No — Agent ID billableboolean No — Whether billable executed_atstring No — When the work was performed notestring No — The note value time_spentstring No — Time spent in hh:mm format
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the time entry to update" }, "agent_id" : { "type" : "integer" , "description" : "Agent ID" }, "billable" : { "type" : "boolean" , "description" : "Whether billable" }, "executed_at" : { "type" : "string" , "description" : "When the work was performed" }, "note" : { "type" : "string" , "description" : "The note value" }, "time_spent" : { "type" : "string" , "description" : "Time spent in hh:mm format" } }, "required" : [ "PCID" , "id" ] }
freshdesk_support_update_topic Update a topic
Parameters: Parameter Type Required Default Description idinteger Yes — ID of the topic to update lockedboolean No — Whether to lock the topic messagestring No — HTML content of the topic body stickyboolean No — Whether to pin the topic titlestring No — Title of the topic
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "id" : { "type" : "integer" , "description" : "ID of the topic to update" }, "locked" : { "type" : "boolean" , "description" : "Whether to lock the topic" }, "message" : { "type" : "string" , "description" : "HTML content of the topic body" }, "sticky" : { "type" : "boolean" , "description" : "Whether to pin the topic" }, "title" : { "type" : "string" , "description" : "Title of the topic" } }, "required" : [ "PCID" , "id" ] }
