Update an article
Changes any part of the article. Unlike create, status is honoured here — this is how an article gets published, by sending status: "published". Sending no article key at all is accepted and changes nothing.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the article.
1
Body
Fields accepted when updating an article. Unlike create, this accepts status.
The title of the article
"Article Title"
The slug of the article
"article-title"
article position in category
1
The text content.
"This is the content of the article"
The description of the article
"This is the description of the article"
The category id of the article
1
The author agent id of the article
1
To associate similar articles to each other, e.g to provide the link for the reference.
2
0 = draft, 1 = published, 2 = archived. Responses return the name as a string ("draft", "published", "archived"), not this integer.
0, 1, 2 The locale of the article
"en"
Use for search
Response
Success
Single-article responses are wrapped in a payload key.
An article as the Help Center API renders it. Note that this is not the database row — category and author come back as nested objects rather than as category_id and author_id.