Skip to main content
Server path: /gleap-helpcenter | Type: Application | PCID required: Yes

Tools


gleap_helpcenter_answer_help_center_question

Answer help center question Parameters:
ParameterTypeRequiredDefaultDescription
questionstringYesThe question to answer from help center content

gleap_helpcenter_create_helpcenter_article

Create a new article Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterCollectionIdstringYesThe helpcenterCollectionId identifier
authorstringNoThe author value
baseAudienceFilterobjectNoBase Audience Filter
contentobjectNoThe content value
descriptionobjectNoThe description value
docIdnumberNoDoc Id
extendedAudienceFilterobjectNoExtended Audience Filter
externalIdstringNoExternal Id
helpcenterCollectionstringNoHelpcenter Collection
isDraftbooleanNoIs Draft
lexorankstringNoThe lexorank value
newCollectionIdstringNoNew Collection Id
plainContentobjectNoPlain Content
projectstringNoThe project value
tagsany[]NoThe tags value
targetAudiencestringNoTarget Audience
titleobjectNoThe title value
upvotesobjectNoThe upvotes value

gleap_helpcenter_create_helpcenter_collection

Create a new collection Parameters:
ParameterTypeRequiredDefaultDescription
baseAudienceFilterobjectNoBase Audience Filter
descriptionobjectNoThe description value
docIdnumberNoDoc Id
extendedAudienceFilterobjectNoExtended Audience Filter
externalIdstringNoExternal Id
iconUrlstringNoIcon Url
lexorankstringNoThe lexorank value
parentstringNoThe parent value
projectstringNoThe project value
targetAudiencestringNoTarget Audience
titleobjectNoThe title value

gleap_helpcenter_create_helpcenter_redirect

Create a new redirect. Parameters:
ParameterTypeRequiredDefaultDescription
matchTypestringYesMatch Type
newUrlstringYesNew Url
oldUrlstringYesOld Url

gleap_helpcenter_delete_article_item

Delete an article Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterArticleIdstringYesHelpcenter Article Id
helpcenterCollectionIdstringYesThe helpcenterCollectionId identifier

gleap_helpcenter_delete_collection

Delete a collection Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterCollectionIdstringYesHelpcenter Collection Id

gleap_helpcenter_delete_redirect

Delete a redirect Parameters:
ParameterTypeRequiredDefaultDescription
redirectIdstringYesRedirect Id

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 Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterArticleIdstringYesHelpcenter Article Id
helpcenterCollectionIdstringYesThe helpcenterCollectionId identifier

gleap_helpcenter_get_articles

Get all articles Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterCollectionIdstringYesThe helpcenterCollectionId identifier

gleap_helpcenter_get_collection_item

Get a collection Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterCollectionIdstringYesHelpcenter Collection Id

gleap_helpcenter_get_collections

Get all collections

gleap_helpcenter_get_sources

Get help center sources

gleap_helpcenter_move_helpcenter_article_item

Move an article Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterArticleIdstringYesHelpcenter Article Id
helpcenterCollectionIdstringYesThe helpcenterCollectionId identifier
newCollectionIdstringYesNew Collection Id

gleap_helpcenter_search_helpcenter_articles

Search help center articles Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesSearch query to find help center articles

gleap_helpcenter_unpublish_helpcenter_collection

Toggle publish status Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterCollectionIdstringYesHelpcenter Collection Id
unpublishedbooleanYesThe unpublished value

gleap_helpcenter_update_helpcenter_article_item

Update an article Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterArticleIdstringYesHelpcenter Article Id
helpcenterCollectionIdstringYesThe helpcenterCollectionId identifier
authorstringNoThe author value
baseAudienceFilterobjectNoBase Audience Filter
contentobjectNoThe content value
descriptionobjectNoThe description value
docIdnumberNoDoc Id
extendedAudienceFilterobjectNoExtended Audience Filter
externalIdstringNoExternal Id
helpcenterCollectionstringNoHelpcenter Collection
isDraftbooleanNoIs Draft
lexorankstringNoThe lexorank value
newCollectionIdstringNoNew Collection Id
plainContentobjectNoPlain Content
projectstringNoThe project value
tagsany[]NoThe tags value
targetAudiencestringNoTarget Audience
titleobjectNoThe title value
upvotesobjectNoThe upvotes value

gleap_helpcenter_update_helpcenter_collection

Update a collection Parameters:
ParameterTypeRequiredDefaultDescription
helpcenterCollectionIdstringYesHelpcenter Collection Id
baseAudienceFilterobjectNoBase Audience Filter
descriptionobjectNoThe description value
docIdnumberNoDoc Id
extendedAudienceFilterobjectNoExtended Audience Filter
externalIdstringNoExternal Id
iconUrlstringNoIcon Url
lexorankstringNoThe lexorank value
parentstringNoThe parent value
projectstringNoThe project value
targetAudiencestringNoTarget Audience
titleobjectNoThe title value

gleap_helpcenter_update_redirect

Update a redirect. Parameters:
ParameterTypeRequiredDefaultDescription
redirectIdstringYesRedirect Id
matchTypestringYesMatch Type
newUrlstringYesNew Url
oldUrlstringYesOld Url