PUT
/
helpcenter
/
collections
/
{helpcenterCollectionId}
/
articles
/
{helpcenterArticleId}
curl --request PUT \
  --url https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/articles/{helpcenterArticleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<any>",
  "description": "<any>",
  "content": "<any>",
  "plainContent": "<any>",
  "helpcenterCollection": "<string>",
  "author": "<string>",
  "project": "<string>",
  "isDraft": true,
  "docId": 123,
  "lexorank": "<string>",
  "upvotes": "<any>",
  "targetAudience": "all",
  "externalId": "<string>",
  "baseAudienceFilter": "<any>",
  "extendedAudienceFilter": "<any>",
  "tags": [
    "<string>"
  ],
  "newCollectionId": "<string>"
}'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "extendedAudienceFilter": "<any>",
  "baseAudienceFilter": "<any>",
  "externalId": "<string>",
  "docId": 123,
  "author": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "helpcenterCollection": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "upvotes": "<any>",
  "plainContent": "<any>",
  "lexorank": "<string>",
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {},
    "cacheHexString": "<any>",
    "prototype": "<string>"
  },
  "content": "<any>",
  "title": "<any>",
  "description": "<any>",
  "isDraft": true,
  "tags": [
    "<string>"
  ],
  "targetAudience": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
helpcenterArticleId
string
required

Body

application/json
​
title
any
​
description
any
​
content
any
​
plainContent
any
​
helpcenterCollection
string
​
author
string
​
project
string
​
isDraft
boolean
default:true
​
docId
number
​
lexorank
string
​
upvotes
any
​
targetAudience
string
default:all
​
externalId
string
​
baseAudienceFilter
any
​
extendedAudienceFilter
any
​
tags
string[]
​
newCollectionId
string

Response

200 - application/json
Ok
​
updatedAt
string
required
​
createdAt
string
required
​
isDraft
boolean
required
​
tags
string[]
required
​
targetAudience
string
required
​
extendedAudienceFilter
any
​
baseAudienceFilter
any
​
externalId
string
​
docId
number
​
author
object
​
helpcenterCollection
object
​
upvotes
any
​
plainContent
any
​
lexorank
string
​
project
object
​
content
any
​
title
any
​
description
any