Update docs article

Update a help-center article. content replaces the whole body and is rejected when it leaves out an image the article still has. Pass language to upsert a translation row; non-translatable fields always apply to the base. Requires the docs:write scope.

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>",
  "allow_image_removal": true,
  "summary": "<string>",
  "published": true,
  "archived": true,
  "show_on_home_page": true,
  "group_id": "<string>",
  "order": 1,
  "parent_article_id": "<string>",
  "portal_instance_id": "<string>",
  "icon": "<string>",
  "url_name": "<string>",
  "image_url": "<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,
  "visibility": "public",
  "visibility_tier": "public",
  "kind": "doc",
  "external_url": "<string>",
  "archived": true,
  "show_on_home_page": true,
  "image_url": "<string>",
  "group_id": "<string>",
  "parent_article_id": "<string>",
  "order": 123,
  "portal_instance_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. Replaces the whole body, so carry over every image, table, embed and tabs block the article already has. Example keys, ids and tokens are placeholders like <your-widget-key />, never a made-up value that looks real. House shape: one ## per section, a --- divider above each one that has content above it, > for a callout, and backticks for a navigation path.

Minimum string length: 1

allow_image_removal · boolean

Defaults to false, which rejects a body that leaves out an image the article still has. Set to true to delete those images.

summary · string

Maximum string length: 300

published · boolean

visibility · enum<string>

agent keeps the article off your docs site while the Productlane Agent still answers from it. internal restricts it to the AI Assistant. unlisted is the former name for agent.

Available options: public, agent, internal, unlisted

archived · boolean

show_on_home_page · boolean

group_id · string | null

Pass null to detach the article from any group.

order · integer

Position among its siblings, ascending.

Required range: x >= 0

parent_article_id · string | null

Root-level article id to nest this article under as a subpage. null lifts it back to the top level of its group.

portal_instance_id · string | null

Portal instance id to assign, from GET /portal/instances. Omit to follow the group or parent the item belongs to; null targets the Main (Root) portal. A value that disagrees with the group's portal is rejected.

icon · string

Nucleo icon name in PascalCase.

Required string length: 1 - 64

url_name · string

Public docs path, like guides/getting-started. The previous path keeps redirecting to the article.

Required string length: 1 - 200

image_url · string<uri> | null

Cover image URL, from POST /api/v2/files. null removes the cover; leaving the field out keeps the current one. The blur placeholder is recomputed.

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

visibility · enum<string> · required

Whether the article is on your docs site. Deprecated: read visibility_tier for the agent and internal split.

Available options: public, unlisted

visibility_tier · enum<string> · required

agent and internal articles both stay off your docs site and out of portal search. The Productlane Agent answers customers from an agent article, and never links it. An internal article is read by the AI Assistant alone.

Available options: public, agent, internal

kind · enum<string> · required

link rows point at a page you host elsewhere: content is empty and external_url holds the address.

Available options: doc, link

external_url · string | null · required

archived · boolean · required

show_on_home_page · boolean · required

image_url · string | null · required

group_id · string | null · required

parent_article_id · string | null · required

order · integer · required

Position among its siblings, ascending. Sort by it to match the order the docs site renders.

portal_instance_id · string | null · required