Skip to main content
Help Centers

Create an article

Creates a new article in your organization's help center.

POST
/v2/help_center/articles

Request Body

Required attributes:

  • title - The title of the article

Optional attributes:

  • description - A brief description of the article
  • body - The HTML content of the article (supports external image URLs and base64 data URIs)
  • formatter - Content formatter: "default" or "ai" (AI converts markdown/html to Featurebase format)
  • parentId - The ID of the parent collection. When provided, the article is created in the Help Center that owns the collection
  • helpCenterId - The ID of the Help Center to create the article in. Use this for root-level articles in a non-default Help Center
  • icon - Icon object with type and value
  • state - "live" or "draft" (defaults to "draft")
  • translations - Dictionary of translations keyed by locale

Help Center Placement

If parentId is provided, the parent collection determines the target Help Center. If both parentId and helpCenterId are provided, the parent collection must belong to the requested Help Center. If neither is provided, the article is created in the organization's active Help Center.

Response

Returns the created 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

Authorizations

Authorizationstringheaderrequired

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

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
bodystring

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. External image URLs and base64 data URIs are uploaded to our storage automatically.

Example: <p>Welcome to our getting started guide.</p>
descriptionstring

A brief description of the article

Maximum string length: 512
Example: Learn how to get started with our platform
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
helpCenterIdstring

The ID of the help center to create the article in. If parentId is provided, it must belong to this help center.

Required string length: 1 - 16
Pattern: ^[a-zA-Z0-9]+$
Example: h7l3snparrtl08hn
iconobject | null

Icon object for the article

parentIdstring

The ID of the parent collection

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

Article state - "live" publishes immediately, "draft" saves as draft

Available options: live, draft
Example: draft
titlestringrequired

The title of the article

Maximum string length: 512
Example: Getting Started Guide
translationsobject

Dictionary of 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