Help Centers

Create an article

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

POST

/v2/help_center/articles

Create an article

curl --request POST \
  --url https://do.featurebase.app/v2/help_center/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<p>Welcome to our getting started guide.</p>",
  "description": "Learn how to get started with our platform",
  "formatter": "default",
  "helpCenterId": "h7l3snparrtl08hn",
  "icon": {
    "type": "emoji",
    "value": "📖"
  },
  "parentId": "6474684",
  "state": "draft",
  "title": "Getting Started Guide",
  "translations": {
    "am": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ar": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "az": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "bg": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "bn": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "bs": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ca": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "cs": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "da": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "de": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "el": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "en": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "es": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "et": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "fa": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "fi": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "fr": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "gu": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ha": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "he": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "hi": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "hr": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ht": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "hu": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "id": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ig": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "it": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ja": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "jv": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "kk": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "km": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "kn": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ko": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "lo": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "lt": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "lv": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ml": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "mn": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "mr": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ms": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "my": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "nb": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ne": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "nl": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "pa": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "pl": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ps": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "pt": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "pt-BR": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ro": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ru": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "sd": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "si": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "sk": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "sl": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "so": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "sr": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "sv": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "sw": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ta": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "te": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "th": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "tl": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "tr": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "uk": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "ur": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "uz": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "vi": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "yo": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "zh-CN": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    },
    "zh-TW": {
      "body": "<p>Welcome to our guide.</p>",
      "description": "Learn how to get started",
      "title": "Getting Started Guide"
    }
  }
}
'

{
  "author": {
    "authorId": "507f1f77bcf86cd799439011",
    "avatarUrl": null,
    "name": "John Doe"
  },
  "availableLocales": [
    "en",
    "de"
  ],
  "body": "<p>Welcome to our guide.</p>",
  "createdAt": "2024-10-18T12:33:09.099Z",
  "defaultLocale": "en",
  "description": "Learn how to get started",
  "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide",
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide",
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "icon": {
    "type": "emoji",
    "value": "📖"
  },
  "id": "1234567",
  "isDraftDiffersFromLive": false,
  "isPublished": true,
  "liveUpdatedAt": "2024-10-18T13:03:25.921Z",
  "locale": "en",
  "object": "article",
  "order": 1,
  "organization": "6595518396205e06b897ad65",
  "parentId": "6474684",
  "path": "/getting-started",
  "publishedLocales": [
    "en"
  ],
  "slug": "1234567-getting-started-guide",
  "state": "live",
  "surveyId": "6743752ca81ae59d25cf834b",
  "title": "Getting Started Guide",
  "translationCreatedAt": "2024-10-18T12:33:09.099Z",
  "translationUpdatedAt": "2024-10-19T14:22:15.123Z",
  "translations": {
    "am": {},
    "ar": {},
    "az": {},
    "bg": {},
    "bn": {},
    "bs": {},
    "ca": {},
    "cs": {},
    "da": {},
    "de": {},
    "el": {},
    "en": {},
    "es": {},
    "et": {},
    "fa": {},
    "fi": {},
    "fr": {},
    "gu": {},
    "ha": {},
    "he": {},
    "hi": {},
    "hr": {},
    "ht": {},
    "hu": {},
    "id": {},
    "ig": {},
    "it": {},
    "ja": {},
    "jv": {},
    "kk": {},
    "km": {},
    "kn": {},
    "ko": {},
    "lo": {},
    "lt": {},
    "lv": {},
    "ml": {},
    "mn": {},
    "mr": {},

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

Autorizaciones

Authorizationstringheaderobligatorio

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

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Ejemplo: 2026-08-19.orbit

Cuerpo

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.

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

descriptionstring

A brief description of the article

Maximum string length: 512

Ejemplo: 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.

Opciones disponibles: default, ai, raw

Ejemplo: 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

Patrón: ^[a-zA-Z0-9]+$

Ejemplo: h7l3snparrtl08hn

iconobject | null

Icon object for the article

Mostrar child attributes

parentIdstring

The ID of the parent collection

Required string length: 1 - 16

Patrón: ^[a-zA-Z0-9]+$

Ejemplo: 6474684

stateenum<string>default:draft

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

Opciones disponibles: live, draft

Ejemplo: draft

titlestringobligatorio

The title of the article

Maximum string length: 512

Ejemplo: Getting Started Guide

translationsobject

Dictionary of translations keyed by locale code

Mostrar child attributes

Respuesta

Success

authorobject

Article author

Mostrar child attributes

availableLocalesenum<string>[]obligatorio

Available locales

bodystring

Article body content (HTML)

Ejemplo: <p>Welcome to our guide.</p>

createdAtstringobligatorio

ISO 8601 timestamp when created

Ejemplo: 2024-10-18T12:33:09.099Z

defaultLocaleenum<string>

Default locale

Opciones disponibles: 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

Ejemplo: en

descriptionstring

Article description

Ejemplo: Learn how to get started

externalUrlstring

External URL

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

featurebaseUrlstring

Featurebase URL

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

helpCenterIdstringobligatorio

Help Center ID

Ejemplo: j7c5g8ah3ewxp4lo

iconobject | null

Article icon

Mostrar child attributes

idstringobligatorio

Article unique identifier

Ejemplo: 1234567

isDraftDiffersFromLiveboolean

Whether draft differs from live

Ejemplo: false

isPublishedboolean

Whether the article is published

Ejemplo: true

liveUpdatedAtstring

ISO 8601 timestamp when live version was last updated

Ejemplo: 2024-10-18T13:03:25.921Z

localeenum<string>obligatorio

Current locale

Ejemplo: en

objectenum<string>obligatorio

Object type identifier

Opciones disponibles: article

Ejemplo: article

ordernumber | null

Display order

Ejemplo: 1

organizationstringobligatorio

Organization ID

Ejemplo: 6595518396205e06b897ad65

parentIdstring | null

Parent collection ID

Ejemplo: 6474684

pathstring

Path to article within help center hierarchy

Ejemplo: /getting-started

publishedLocalesenum<string>[]

Published locales

slugstring

URL slug

Ejemplo: 1234567-getting-started-guide

stateenum<string>obligatorio

Article state

Opciones disponibles: live, draft

Ejemplo: live

surveyIdstring

Associated survey ID

Ejemplo: 6743752ca81ae59d25cf834b

titlestring

Article title

Ejemplo: Getting Started Guide

translationCreatedAtstring

ISO 8601 timestamp when translation was created

Ejemplo: 2024-10-18T12:33:09.099Z

translationUpdatedAtstring

ISO 8601 timestamp when translation was last updated

Ejemplo: 2024-10-19T14:22:15.123Z

translationsobject

Translations by locale code

Mostrar child attributes

updatedAtstringobligatorio

ISO 8601 timestamp when last updated

Ejemplo: 2024-10-18T13:03:25.921Z

visibleBystring[]

Visibility settings

¿Aún necesitas ayuda? Pregunta al equipo