Skip to main content
PATCH
/
docs
/
articles
/
{id}
Update doc article
curl --request PATCH \
  --url https://productlane.com/api/v1/docs/articles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "summary": "<string>",
  "published": true,
  "archived": true,
  "showOnHomePage": true
}
'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true,
  "version": 123,
  "order": 123,
  "date": "2023-11-07T05:31:56Z",
  "published": true,
  "title": "<string>",
  "icon": "<string>",
  "summary": "<string>",
  "archived": true,
  "urlName": "<string>",
  "showOnHomePage": true,
  "imageUrl": "<string>",
  "imageBlurhash": "<string>",
  "workspaceId": "<string>",
  "helpCenterGroupId": "<string>",
  "content": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required
Minimum string length: 1

Body

application/json
​
title
string
Minimum string length: 1
​
content
string
Minimum string length: 1
​
summary
string
​
published
boolean
​
archived
boolean
​
showOnHomePage
boolean

Response

Successful response

​
id
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
isDeleted
boolean
required
​
version
number
required
​
order
number
required
​
date
string<date-time> | null
required
​
published
boolean
required
​
title
string
required
​
icon
string
required
​
summary
string
required
​
archived
boolean
required
​
urlName
string
required
​
showOnHomePage
boolean
required
​
imageUrl
string | null
required
​
imageBlurhash
string | null
required
​
workspaceId
string
required
​
helpCenterGroupId
string | null
required
​
content
any