Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 1.69 KB

File metadata and controls

17 lines (14 loc) · 1.69 KB

# ArticleUpdateArticle

Properties

Name Type Description Notes
title string [optional]
bodyMarkdown string The body of the article. It can contain an optional front matter. For example ```markdown --- title: Hello, World! published: true tags: discuss, help date: 20190701T10:00Z series: Hello series canonical_url: https://example.com/blog/hello cover_image: article_published_cover_image --- ``` `date`, `series` and `canonical_url` are optional. `date` is the publication date-time `series` is the name of the series the article belongs to `canonical_url` is the canonical URL of the article `cover_image` is the main image of the article If the markdown contains a front matter, it will take precedence on the equivalent params given in the payload. [optional]
published bool True to create a published article, false otherwise. Defaults to false [optional]
series string Article series name. All articles belonging to the same series need to have the same name in this parameter. To remove an article from a series, the `null` value can be used. [optional]
mainImage string [optional]
canonicalUrl string [optional]
description string [optional]
tags string[] [optional]
organizationId int Only users belonging to an organization can assign the article to it [optional]

[Back to Model list] [Back to API list] [Back to README]