Skip to main content
Help Centers

Update an article

Updates an existing article. Only include the fields you wish to update.

PATCH
/v2/help_center/articles/{id}

Path Parameters

  • id - The unique identifier of the article to update

Request Body

All fields are optional. Only provided fields will be updated:

  • title - The new title of the article
  • description - The new description of the article
  • body - The new HTML content of the article
  • formatter - Content formatter: "default" or "ai"
  • icon - Updated icon object for the article
  • parentId - New parent collection ID
  • authorId - ID of the new author (must be a member of the organization)
  • state - "live" or "draft" - if "live", publishes immediately
  • translations - Dictionary of updated translations keyed by locale

Response

Returns the updated article object with:

  • id - Unique identifier
  • title - Article title
  • description - Article description
  • body - Article content (HTML)
  • slug - URL slug
  • icon - Article icon (emoji or custom)
  • parentId - Parent collection ID
  • helpCenterId - ID of the help center this article belongs to
  • organization - Organization ID
  • state - Article state (live or draft)
  • author - Author information (name, authorId, avatarUrl)
  • translations - Translations for different locales
  • createdAt - ISO 8601 timestamp when created
  • updatedAt - ISO 8601 timestamp when last updated

Errors

  • 404 - Article not found in your organization's help center

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

The article unique identifier

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: 1234567

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Body

application/json
authorIdstring

ID of the new author (must be a member of the organization)

Example: 507f1f77bcf86cd799439011
bodystring

New HTML (or markdown) content of the article. HTML supports Featurebase custom blocks (callouts, multi-code, accordions, columns, file/image/video, iframes) — see the Content Components guide.

Example: <p>Updated content.</p>
descriptionstring

The new description of the article

Maximum string length: 512
Example: Updated description
formatterenum<string>default:default

Content formatter. raw stores Featurebase-canonical HTML verbatim after XSS sanitization — formatting (alignment, colors, classes, blank-line spacers, accordions) is preserved byte-for-byte. Use this whenever you are editing an article whose body you previously read from this API. default applies lossy cleanup meant for foreign HTML/markdown; ai runs the input through Featurebase AI to convert arbitrary markdown / HTML / docs from other tools into our custom block format (callouts, multi-code, accordions, columns). Never use default or ai to re-save an existing article body.

Available options: default, ai, raw
Example: default
iconobject | null

Icon object for the article

parentIdstring | null

New parent collection ID

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: 6474684
stateenum<string>

Article state - if "live", publishes immediately

Available options: live, draft
Example: live
titlestring

The new title of the article

Maximum string length: 512
Example: Updated Getting Started Guide
translationsobject

Dictionary of updated translations keyed by locale code

Response

application/json

Success

authorobject

Article author

availableLocalesenum<string>[]required

Available locales

bodystring

Article body content (HTML)

Example: <p>Welcome to our guide.</p>
createdAtstringrequired

ISO 8601 timestamp when created

Example: 2024-10-18T12:33:09.099Z
defaultLocaleenum<string>

Default locale

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, bn, bs, pt-BR, bg, ca, hr, cs, da, nl, en, et, fi, fr, de, el, hi, hu, id, it, ja, ko, lv, lt, ms, mn, nb, pl, pt, ro, ru, sr, zh-CN, sk, sl, es, sw, sv, th, zh-TW, tr, uk, vi
Example: en
descriptionstring

Article description

Example: Learn how to get started
externalUrlstring

External URL

Example: https://help.yourdomain.com/en/articles/1234567-getting-started-guide
featurebaseUrlstring

Featurebase URL

Example: https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide
helpCenterIdstringrequired

Help Center ID

Example: j7c5g8ah3ewxp4lo
iconobject | null

Article icon

idstringrequired

Article unique identifier

Example: 1234567
isDraftDiffersFromLiveboolean

Whether draft differs from live

Example: false
isPublishedboolean

Whether the article is published

Example: true
liveUpdatedAtstring

ISO 8601 timestamp when live version was last updated

Example: 2024-10-18T13:03:25.921Z
localeenum<string>required

Current locale

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, bn, bs, pt-BR, bg, ca, hr, cs, da, nl, en, et, fi, fr, de, el, hi, hu, id, it, ja, ko, lv, lt, ms, mn, nb, pl, pt, ro, ru, sr, zh-CN, sk, sl, es, sw, sv, th, zh-TW, tr, uk, vi
Example: en
objectenum<string>required

Object type identifier

Available options: article
Example: article
ordernumber | null

Display order

Example: 1
organizationstringrequired

Organization ID

Example: 6595518396205e06b897ad65
parentIdstring | null

Parent collection ID

Example: 6474684
pathstring

Path to article within help center hierarchy

Example: /getting-started
publishedLocalesenum<string>[]

Published locales

slugstring

URL slug

Example: 1234567-getting-started-guide
stateenum<string>required

Article state

Available options: live, draft
Example: live
surveyIdstring

Associated survey ID

Example: 6743752ca81ae59d25cf834b
titlestring

Article title

Example: Getting Started Guide
translationCreatedAtstring

ISO 8601 timestamp when translation was created

Example: 2024-10-18T12:33:09.099Z
translationUpdatedAtstring

ISO 8601 timestamp when translation was last updated

Example: 2024-10-19T14:22:15.123Z
translationsobject

Translations by locale code

updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: 2024-10-18T13:03:25.921Z
visibleBystring[]

Visibility settings

Still need help? Ask the team