Update Article Request Payload

You can Update an Article

title
string

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

description
string

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

body
string

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

author_id
integer

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.

state
string

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"
parent_id
string

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

parent_type
string

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

object 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", } }