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: /gleap-helpcenter | Type: Application | PCID required: Yesgleap_helpcenter_answer_help_center_question Answer help center question
Parameters: Parameter Type Required Default Description questionstring Yes — The question to answer from help center content
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "question" : { "type" : "string" , "description" : "The question to answer from help center content" } }, "required" : [ "PCID" , "question" ] }
gleap_helpcenter_create_helpcenter_article Create a new article
Parameters: Parameter Type Required Default Description helpcenterCollectionIdstring Yes — The helpcenterCollectionId identifier authorstring No — The author value baseAudienceFilterobject No — Base Audience Filter contentobject No — The content value descriptionobject No — The description value docIdnumber No — Doc Id extendedAudienceFilterobject No — Extended Audience Filter externalIdstring No — External Id helpcenterCollectionstring No — Helpcenter Collection isDraftboolean No — Is Draft lexorankstring No — The lexorank value newCollectionIdstring No — New Collection Id plainContentobject No — Plain Content projectstring No — The project value tagsstring[] No — The tags value targetAudiencestring No — Target Audience titleobject No — The title value upvotesobject No — The upvotes value
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "The helpcenterCollectionId identifier" }, "author" : { "type" : "string" , "description" : "The author value" }, "baseAudienceFilter" : { "description" : "Base Audience Filter" }, "content" : { "description" : "The content value" }, "description" : { "description" : "The description value" }, "docId" : { "type" : "number" , "description" : "Doc Id" }, "extendedAudienceFilter" : { "description" : "Extended Audience Filter" }, "externalId" : { "type" : "string" , "description" : "External Id" }, "helpcenterCollection" : { "type" : "string" , "description" : "Helpcenter Collection" }, "isDraft" : { "type" : "boolean" , "description" : "Is Draft" }, "lexorank" : { "type" : "string" , "description" : "The lexorank value" }, "newCollectionId" : { "type" : "string" , "description" : "New Collection Id" }, "plainContent" : { "description" : "Plain Content" }, "project" : { "type" : "string" , "description" : "The project value" }, "tags" : { "type" : "array" , "items" : { "type" : "string" }, "description" : "The tags value" }, "targetAudience" : { "type" : "string" , "description" : "Target Audience" }, "title" : { "description" : "The title value" }, "upvotes" : { "description" : "The upvotes value" } }, "required" : [ "PCID" , "helpcenterCollectionId" ] }
gleap_helpcenter_create_helpcenter_collection Create a new collection
Parameters: Parameter Type Required Default Description baseAudienceFilterobject No — Base Audience Filter descriptionobject No — The description value docIdnumber No — Doc Id extendedAudienceFilterobject No — Extended Audience Filter externalIdstring No — External Id iconUrlstring No — Icon Url lexorankstring No — The lexorank value parentstring No — The parent value projectstring No — The project value targetAudiencestring No — Target Audience titleobject No — The title value
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "baseAudienceFilter" : { "description" : "Base Audience Filter" }, "description" : { "description" : "The description value" }, "docId" : { "type" : "number" , "description" : "Doc Id" }, "extendedAudienceFilter" : { "description" : "Extended Audience Filter" }, "externalId" : { "type" : "string" , "description" : "External Id" }, "iconUrl" : { "type" : "string" , "description" : "Icon Url" }, "lexorank" : { "type" : "string" , "description" : "The lexorank value" }, "parent" : { "type" : "string" , "description" : "The parent value" }, "project" : { "type" : "string" , "description" : "The project value" }, "targetAudience" : { "type" : "string" , "description" : "Target Audience" }, "title" : { "description" : "The title value" } }, "required" : [ "PCID" ] }
gleap_helpcenter_create_helpcenter_redirect Create a new redirect.
Parameters: Parameter Type Required Default Description matchTypestring Yes — Match Type newUrlstring Yes — New Url oldUrlstring Yes — Old Url
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "matchType" : { "type" : "string" , "description" : "Match Type" , "enum" : [ "exact" , "pattern" ] }, "newUrl" : { "type" : "string" , "description" : "New Url" }, "oldUrl" : { "type" : "string" , "description" : "Old Url" } }, "required" : [ "PCID" , "matchType" , "newUrl" , "oldUrl" ] }
gleap_helpcenter_delete_article_item Delete an article
Parameters: Parameter Type Required Default Description helpcenterArticleIdstring Yes — Helpcenter Article Id helpcenterCollectionIdstring Yes — The helpcenterCollectionId identifier
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterArticleId" : { "type" : "string" , "description" : "Helpcenter Article Id" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "The helpcenterCollectionId identifier" } }, "required" : [ "PCID" , "helpcenterArticleId" , "helpcenterCollectionId" ] }
gleap_helpcenter_delete_collection Delete a collection
Parameters: Parameter Type Required Default Description helpcenterCollectionIdstring Yes — Helpcenter Collection Id
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "Helpcenter Collection Id" } }, "required" : [ "PCID" , "helpcenterCollectionId" ] }
gleap_helpcenter_delete_redirect Delete a redirect
Parameters: Parameter Type Required Default Description redirectIdstring Yes — Redirect Id
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "redirectId" : { "type" : "string" , "description" : "Redirect Id" } }, "required" : [ "PCID" , "redirectId" ] }
gleap_helpcenter_find_redirects Find all redirects.
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
gleap_helpcenter_get_all_helpcenter_collections Get all collections with subcollections
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
gleap_helpcenter_get_article_item Get an article
Parameters: Parameter Type Required Default Description helpcenterArticleIdstring Yes — Helpcenter Article Id helpcenterCollectionIdstring Yes — The helpcenterCollectionId identifier
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterArticleId" : { "type" : "string" , "description" : "Helpcenter Article Id" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "The helpcenterCollectionId identifier" } }, "required" : [ "PCID" , "helpcenterArticleId" , "helpcenterCollectionId" ] }
gleap_helpcenter_get_articles Get all articles
Parameters: Parameter Type Required Default Description helpcenterCollectionIdstring Yes — The helpcenterCollectionId identifier
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "The helpcenterCollectionId identifier" } }, "required" : [ "PCID" , "helpcenterCollectionId" ] }
gleap_helpcenter_get_collection_item Get a collection
Parameters: Parameter Type Required Default Description helpcenterCollectionIdstring Yes — Helpcenter Collection Id
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "Helpcenter Collection Id" } }, "required" : [ "PCID" , "helpcenterCollectionId" ] }
gleap_helpcenter_get_collections Get all collections
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
gleap_helpcenter_get_sources Get help center sources
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" } }, "required" : [ "PCID" ] }
gleap_helpcenter_move_helpcenter_article_item Move an article
Parameters: Parameter Type Required Default Description helpcenterArticleIdstring Yes — Helpcenter Article Id helpcenterCollectionIdstring Yes — The helpcenterCollectionId identifier newCollectionIdstring Yes — New Collection Id
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterArticleId" : { "type" : "string" , "description" : "Helpcenter Article Id" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "The helpcenterCollectionId identifier" }, "newCollectionId" : { "type" : "string" , "description" : "New Collection Id" } }, "required" : [ "PCID" , "helpcenterArticleId" , "helpcenterCollectionId" , "newCollectionId" ] }
gleap_helpcenter_search_helpcenter_articles Search help center articles
Parameters: Parameter Type Required Default Description querystring Yes — Search query to find help center articles
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "query" : { "type" : "string" , "description" : "Search query to find help center articles" } }, "required" : [ "PCID" , "query" ] }
gleap_helpcenter_unpublish_helpcenter_collection Toggle publish status
Parameters: Parameter Type Required Default Description helpcenterCollectionIdstring Yes — Helpcenter Collection Id unpublishedboolean Yes — The unpublished value
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "Helpcenter Collection Id" }, "unpublished" : { "type" : "boolean" , "description" : "The unpublished value" } }, "required" : [ "PCID" , "helpcenterCollectionId" , "unpublished" ] }
gleap_helpcenter_update_helpcenter_article_item Update an article
Parameters: Parameter Type Required Default Description helpcenterArticleIdstring Yes — Helpcenter Article Id helpcenterCollectionIdstring Yes — The helpcenterCollectionId identifier authorstring No — The author value baseAudienceFilterobject No — Base Audience Filter contentobject No — The content value descriptionobject No — The description value docIdnumber No — Doc Id extendedAudienceFilterobject No — Extended Audience Filter externalIdstring No — External Id helpcenterCollectionstring No — Helpcenter Collection isDraftboolean No — Is Draft lexorankstring No — The lexorank value newCollectionIdstring No — New Collection Id plainContentobject No — Plain Content projectstring No — The project value tagsstring[] No — The tags value targetAudiencestring No — Target Audience titleobject No — The title value upvotesobject No — The upvotes value
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterArticleId" : { "type" : "string" , "description" : "Helpcenter Article Id" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "The helpcenterCollectionId identifier" }, "author" : { "type" : "string" , "description" : "The author value" }, "baseAudienceFilter" : { "description" : "Base Audience Filter" }, "content" : { "description" : "The content value" }, "description" : { "description" : "The description value" }, "docId" : { "type" : "number" , "description" : "Doc Id" }, "extendedAudienceFilter" : { "description" : "Extended Audience Filter" }, "externalId" : { "type" : "string" , "description" : "External Id" }, "helpcenterCollection" : { "type" : "string" , "description" : "Helpcenter Collection" }, "isDraft" : { "type" : "boolean" , "description" : "Is Draft" }, "lexorank" : { "type" : "string" , "description" : "The lexorank value" }, "newCollectionId" : { "type" : "string" , "description" : "New Collection Id" }, "plainContent" : { "description" : "Plain Content" }, "project" : { "type" : "string" , "description" : "The project value" }, "tags" : { "type" : "array" , "items" : { "type" : "string" }, "description" : "The tags value" }, "targetAudience" : { "type" : "string" , "description" : "Target Audience" }, "title" : { "description" : "The title value" }, "upvotes" : { "description" : "The upvotes value" } }, "required" : [ "PCID" , "helpcenterArticleId" , "helpcenterCollectionId" ] }
gleap_helpcenter_update_helpcenter_collection Update a collection
Parameters: Parameter Type Required Default Description helpcenterCollectionIdstring Yes — Helpcenter Collection Id baseAudienceFilterobject No — Base Audience Filter descriptionobject No — The description value docIdnumber No — Doc Id extendedAudienceFilterobject No — Extended Audience Filter externalIdstring No — External Id iconUrlstring No — Icon Url lexorankstring No — The lexorank value parentstring No — The parent value projectstring No — The project value targetAudiencestring No — Target Audience titleobject No — The title value
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "helpcenterCollectionId" : { "type" : "string" , "description" : "Helpcenter Collection Id" }, "baseAudienceFilter" : { "description" : "Base Audience Filter" }, "description" : { "description" : "The description value" }, "docId" : { "type" : "number" , "description" : "Doc Id" }, "extendedAudienceFilter" : { "description" : "Extended Audience Filter" }, "externalId" : { "type" : "string" , "description" : "External Id" }, "iconUrl" : { "type" : "string" , "description" : "Icon Url" }, "lexorank" : { "type" : "string" , "description" : "The lexorank value" }, "parent" : { "type" : "string" , "description" : "The parent value" }, "project" : { "type" : "string" , "description" : "The project value" }, "targetAudience" : { "type" : "string" , "description" : "Target Audience" }, "title" : { "description" : "The title value" } }, "required" : [ "PCID" , "helpcenterCollectionId" ] }
gleap_helpcenter_update_redirect Update a redirect.
Parameters: Parameter Type Required Default Description redirectIdstring Yes — Redirect Id matchTypestring Yes — Match Type newUrlstring Yes — New Url oldUrlstring Yes — Old Url
{ "type" : "object" , "properties" : { "PCID" : { "type" : "string" , "description" : "Pink Connect ID for the authenticated connection" }, "redirectId" : { "type" : "string" , "description" : "Redirect Id" }, "matchType" : { "type" : "string" , "description" : "Match Type" , "enum" : [ "exact" , "pattern" ] }, "newUrl" : { "type" : "string" , "description" : "New Url" }, "oldUrl" : { "type" : "string" , "description" : "Old Url" } }, "required" : [ "PCID" , "redirectId" , "matchType" , "newUrl" , "oldUrl" ] }
