Update doc article

Update a docs article by ID. Authentication is required.

PATCH /docs/articles/{id}

Update docs article

cURL

curl --request PATCH \
  --url https://productlane.com/api/v2/docs/articles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "summary": "<string>",
  "published": true,
  "archived": true,
  "show_on_home_page": true,
  "group_id": "<string>",
  "icon": "<string>",
  "language": "<string>"
}
'

200

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "content": "<string>",
  "icon": "<string>",
  "url_name": "<string>",
  "published": true,
  "archived": true,
  "show_on_home_page": true,
  "image_url": "<string>",
  "group_id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Body

application/json

title · string

Minimum string length: 1

content · string

Markdown body.

Minimum string length: 1

summary · string

published · boolean

archived · boolean

show_on_home_page · boolean

group_id · string | null

Pass null to detach the article from any group.

icon · string

Nucleo icon name in PascalCase.

Required string length: 1 - 64

language · string

BCP-47 language code. When set, translatable fields upsert a translation row; non-translatable fields always apply to the base.

Response

200

application/json

Successful response

id · string · required

created_at · string · required

updated_at · string · required

title · string · required

summary · string · required

content · string · required

icon · string · required

Name of a Nucleo icon (PascalCase, e.g. Notepad, Atom). Must be a valid icon from https://nucleoapp.com - unknown names will not render in the dashboard or portal.

url_name · string · required

published · boolean · required

archived · boolean · required

show_on_home_page · boolean · required

image_url · string | null · required

group_id · string | null · required