Skip to content
Home/
REST API Reference
/
/
Create Article Request Pa...

Create Article Request Payload

You can create an Article

titlestringrequired

The title of the article.For multilingual articles, this will be the title of the default language's content.

Example:"Thanks for everything"
descriptionstring

The description of the article. For multilingual articles, this will be the description of the default language's content.

Example:"Description of the Article"
bodystring

The content of the article. For multilingual articles, this will be the body of the default language's content.

Example:"<p>This is the body in html</p>"
author_idintegerrequired

The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.

Example:1295
statestring

Whether the article will be published or will be a draft. Defaults to draft. For multilingual articles, this will be the state of the default language's content.

Enum:"published""draft"
Example:"draft"
parent_idinteger

The id of the article's parent collection or section. An article without this field stands alone.

Example:18
parent_typestring

The type of parent, which can either be a collection or section.

Example:"collection"
translated_contentobject or null(Article Translated Content)

The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.

{
  "title": "Thanks for everything",
  "description": "Description of the Article",
  "body": "<p>This is the body in html</p>",
  "author_id": 1295,
  "state": "draft",
  "parent_id": 18,
  "parent_type": "collection",
  "translated_content": {
    "type": "article_translated_content",
    "ar": { … },
    "bg": { … },
    "bs": { … },
    "ca": { … },
    "cs": { … },
    "da": { … },
    "de": { … },
    "el": { … },
    "en": { … },
    "es": { … },
    "et": { … },
    "fi": { … },
    "fr": { … },
    "he": { … },
    "hr": { … },
    "hu": { … },
    "id": { … },
    "it": { … },
    "ja": { … },
    "ko": { … },
    "lt": { … },
    "lv": { … },
    "mn": { … },
    "nb": { … },
    "nl": { … },
    "pl": { … },
    "pt": { … },
    "ro": { … },
    "ru": { … },
    "sl": { … },
    "sr": { … },
    "sv": { … },
    "tr": { … },
    "vi": { … },
    "pt-BR": { … },
    "zh-CN": { … },
    "zh-TW": { … }
  }
}