gleap-helpcenter

Gleap Help Center - articles, collections, redirects, and search

Server path: /gleap-helpcenter | Type: Application | PCID required: Yes

Tools

Tool	Description
gleap_helpcenter_answer_help_center_question	Answer help center question
gleap_helpcenter_create_helpcenter_article	Create a new article
gleap_helpcenter_create_helpcenter_collection	Create a new collection
gleap_helpcenter_create_helpcenter_redirect	Create a new redirect.
gleap_helpcenter_delete_article_item	Delete an article
gleap_helpcenter_delete_collection	Delete a collection
gleap_helpcenter_delete_redirect	Delete a redirect
gleap_helpcenter_find_redirects	Find all redirects.
gleap_helpcenter_get_all_helpcenter_collections	Get all collections with subcollections
gleap_helpcenter_get_article_item	Get an article
gleap_helpcenter_get_articles	Get all articles
gleap_helpcenter_get_collection_item	Get a collection
gleap_helpcenter_get_collections	Get all collections
gleap_helpcenter_get_sources	Get help center sources
gleap_helpcenter_move_helpcenter_article_item	Move an article
gleap_helpcenter_search_helpcenter_articles	Search help center articles
gleap_helpcenter_unpublish_helpcenter_collection	Toggle publish status
gleap_helpcenter_update_helpcenter_article_item	Update an article
gleap_helpcenter_update_helpcenter_collection	Update a collection
gleap_helpcenter_update_redirect	Update a redirect.

---

gleap_helpcenter_answer_help_center_question

Answer help center question

Parameters:

Parameter	Type	Required	Default	Description
question	string	Yes	—	The question to answer from help center content

Show inputSchema

{
  "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
project	string	Yes	—	The project value
helpcenterCollectionId	string	Yes	—	The helpcenterCollectionId identifier
author	string	No	—	The author value
baseAudienceFilter	object	No	—	Base Audience Filter
content	object	No	—	The content value
description	object	No	—	The description value
docId	number	No	—	Doc Id
extendedAudienceFilter	object	No	—	Extended Audience Filter
externalId	string	No	—	External Id
helpcenterCollection	string	No	—	Helpcenter Collection
isDraft	boolean	No	—	Is Draft
lexorank	string	No	—	The lexorank value
newCollectionId	string	No	—	New Collection Id
plainContent	object	No	—	Plain Content
tags	string[]	No	—	The tags value
targetAudience	string	No	—	Target Audience
title	object	No	—	The title value
upvotes	object	No	—	The upvotes value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "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"
    },
    "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",
    "project",
    "helpcenterCollectionId"
  ]
}

---

gleap_helpcenter_create_helpcenter_collection

Create a new collection

Parameters:

Parameter	Type	Required	Default	Description
project	string	Yes	—	The project value
baseAudienceFilter	object	No	—	Base Audience Filter
description	object	No	—	The description value
docId	number	No	—	Doc Id
extendedAudienceFilter	object	No	—	Extended Audience Filter
externalId	string	No	—	External Id
iconUrl	string	No	—	Icon Url
lexorank	string	No	—	The lexorank value
parent	string	No	—	The parent value
targetAudience	string	No	—	Target Audience
title	object	No	—	The title value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "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"
    },
    "targetAudience": {
      "type": "string",
      "description": "Target Audience"
    },
    "title": {
      "description": "The title value"
    }
  },
  "required": [
    "PCID",
    "project"
  ]
}

---

gleap_helpcenter_create_helpcenter_redirect

Create a new redirect.

Parameters:

Parameter	Type	Required	Default	Description
project	string	Yes	—	The project value
matchType	string	Yes	—	Match Type
newUrl	string	Yes	—	New Url
oldUrl	string	Yes	—	Old Url

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "matchType": {
      "type": "string",
      "description": "Match Type",
      "enum": [
        "exact",
        "pattern"
      ]
    },
    "newUrl": {
      "type": "string",
      "description": "New Url"
    },
    "oldUrl": {
      "type": "string",
      "description": "Old Url"
    }
  },
  "required": [
    "PCID",
    "project",
    "matchType",
    "newUrl",
    "oldUrl"
  ]
}

---

gleap_helpcenter_delete_article_item

Delete an article

Parameters:

Parameter	Type	Required	Default	Description
helpcenterArticleId	string	Yes	—	Helpcenter Article Id
project	string	Yes	—	The project value
helpcenterCollectionId	string	Yes	—	The helpcenterCollectionId identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "helpcenterArticleId": {
      "type": "string",
      "description": "Helpcenter Article Id"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "helpcenterCollectionId": {
      "type": "string",
      "description": "The helpcenterCollectionId identifier"
    }
  },
  "required": [
    "PCID",
    "helpcenterArticleId",
    "project",
    "helpcenterCollectionId"
  ]
}

---

gleap_helpcenter_delete_collection

Delete a collection

Parameters:

Parameter	Type	Required	Default	Description
helpcenterCollectionId	string	Yes	—	Helpcenter Collection Id
project	string	Yes	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "helpcenterCollectionId": {
      "type": "string",
      "description": "Helpcenter Collection Id"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    }
  },
  "required": [
    "PCID",
    "helpcenterCollectionId",
    "project"
  ]
}

---

gleap_helpcenter_delete_redirect

Delete a redirect

Parameters:

Parameter	Type	Required	Default	Description
redirectId	string	Yes	—	Redirect Id
project	string	Yes	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "redirectId": {
      "type": "string",
      "description": "Redirect Id"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    }
  },
  "required": [
    "PCID",
    "redirectId",
    "project"
  ]
}

---

gleap_helpcenter_find_redirects

Find all redirects.

Parameters:

Parameter	Type	Required	Default	Description
project	string	Yes	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    }
  },
  "required": [
    "PCID",
    "project"
  ]
}

---

gleap_helpcenter_get_all_helpcenter_collections

Get all collections with subcollections

Parameters:

Parameter	Type	Required	Default	Description
project	string	Yes	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    }
  },
  "required": [
    "PCID",
    "project"
  ]
}

---

gleap_helpcenter_get_article_item

Get an article

Parameters:

Parameter	Type	Required	Default	Description
helpcenterArticleId	string	Yes	—	Helpcenter Article Id
helpcenterCollectionId	string	Yes	—	The helpcenterCollectionId identifier

Show inputSchema

{
  "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
project	string	Yes	—	The project value
helpcenterCollectionId	string	Yes	—	The helpcenterCollectionId identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "helpcenterCollectionId": {
      "type": "string",
      "description": "The helpcenterCollectionId identifier"
    }
  },
  "required": [
    "PCID",
    "project",
    "helpcenterCollectionId"
  ]
}

---

gleap_helpcenter_get_collection_item

Get a collection

Parameters:

Parameter	Type	Required	Default	Description
helpcenterCollectionId	string	Yes	—	Helpcenter Collection Id
project	string	Yes	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "helpcenterCollectionId": {
      "type": "string",
      "description": "Helpcenter Collection Id"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    }
  },
  "required": [
    "PCID",
    "helpcenterCollectionId",
    "project"
  ]
}

---

gleap_helpcenter_get_collections

Get all collections

Parameters:

Parameter	Type	Required	Default	Description
project	string	Yes	—	The project value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    }
  },
  "required": [
    "PCID",
    "project"
  ]
}

---

gleap_helpcenter_get_sources

Get help center sources

Show inputSchema

{
  "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
helpcenterArticleId	string	Yes	—	Helpcenter Article Id
helpcenterCollectionId	string	Yes	—	The helpcenterCollectionId identifier
newCollectionId	string	Yes	—	New Collection Id

Show inputSchema

{
  "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
query	string	Yes	—	Search query to find help center articles

Show inputSchema

{
  "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
helpcenterCollectionId	string	Yes	—	Helpcenter Collection Id
project	string	Yes	—	The project value
unpublished	boolean	Yes	—	The unpublished value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "helpcenterCollectionId": {
      "type": "string",
      "description": "Helpcenter Collection Id"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "unpublished": {
      "type": "boolean",
      "description": "The unpublished value"
    }
  },
  "required": [
    "PCID",
    "helpcenterCollectionId",
    "project",
    "unpublished"
  ]
}

---

gleap_helpcenter_update_helpcenter_article_item

Update an article

Parameters:

Parameter	Type	Required	Default	Description
helpcenterArticleId	string	Yes	—	Helpcenter Article Id
helpcenterCollectionId	string	Yes	—	The helpcenterCollectionId identifier
author	string	No	—	The author value
baseAudienceFilter	object	No	—	Base Audience Filter
content	object	No	—	The content value
description	object	No	—	The description value
docId	number	No	—	Doc Id
extendedAudienceFilter	object	No	—	Extended Audience Filter
externalId	string	No	—	External Id
helpcenterCollection	string	No	—	Helpcenter Collection
isDraft	boolean	No	—	Is Draft
lexorank	string	No	—	The lexorank value
newCollectionId	string	No	—	New Collection Id
plainContent	object	No	—	Plain Content
project	string	No	—	The project value
tags	string[]	No	—	The tags value
targetAudience	string	No	—	Target Audience
title	object	No	—	The title value
upvotes	object	No	—	The upvotes value

Show inputSchema

{
  "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
helpcenterCollectionId	string	Yes	—	Helpcenter Collection Id
baseAudienceFilter	object	No	—	Base Audience Filter
description	object	No	—	The description value
docId	number	No	—	Doc Id
extendedAudienceFilter	object	No	—	Extended Audience Filter
externalId	string	No	—	External Id
iconUrl	string	No	—	Icon Url
lexorank	string	No	—	The lexorank value
parent	string	No	—	The parent value
project	string	No	—	The project value
targetAudience	string	No	—	Target Audience
title	object	No	—	The title value

Show inputSchema

{
  "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
redirectId	string	Yes	—	Redirect Id
project	string	Yes	—	The project value
matchType	string	Yes	—	Match Type
newUrl	string	Yes	—	New Url
oldUrl	string	Yes	—	Old Url

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "redirectId": {
      "type": "string",
      "description": "Redirect Id"
    },
    "project": {
      "type": "string",
      "description": "The project value"
    },
    "matchType": {
      "type": "string",
      "description": "Match Type",
      "enum": [
        "exact",
        "pattern"
      ]
    },
    "newUrl": {
      "type": "string",
      "description": "New Url"
    },
    "oldUrl": {
      "type": "string",
      "description": "Old Url"
    }
  },
  "required": [
    "PCID",
    "redirectId",
    "project",
    "matchType",
    "newUrl",
    "oldUrl"
  ]
}