Update article
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Update article
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
PUT /articles/{id}/{langcode}
Updates an article with the ID
Header
| Parameter | Type | Description |
|---|---|---|
| api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Route Parameter
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | Yes | string | The ID of the article |
| langCode | Yes | string | Language code for multilingual |
Body Parameters
Parameters highlighted in bold are mandatory
| Parameter | Type | Description |
|---|---|---|
| title | string | Article title |
| content | string | Article markdown content. If the editor type is Markdown, use this property |
| html_content | string | Article HTML content. If the editor type is WYSIWYG, use this property |
| category_id | string | Move article to another category |
| hidden | boolean | Hide / Show article |
| version_number | number | Article version to update ( Default is latest ) |
| translation_option | string | Indicates the translation status of the article. 0 - None, 1 - Needs translation, 2 Translated |
| source | string | Free text used for future reference |
Sample Request
{
"title":"My New Title",
"category_id":"650aec55-c0a7-42bf-862c-1eea02b96trt",
"content" : "## My new content",
"hidden" : false
}
Sample Response
{
"data": {
"id": "8ec54551-a2f3-4d2a-b835-b85afaee8abe",
"title": "My New Title",
"content": "## My new content",
"html_content": null,
"category_id": "650aec55-c0a7-42bf-862c-1eea02b98efe",
"project_version_id": "7ba483c0-0929-4bb6-aa43-04a2f4bb8893",
"version_number": 2,
"public_version": 1,
"latest_version": 2,
"hidden": false,
"status": 0,
"order": 0,
"protection_level": 0,
"created_by": "5ae331f74e60146b233558c6",
"authors": [],
"created_at": "2019-02-18T10:59:53.292Z",
"modified_at": "2019-02-21T15:15:39.535Z",
"slug": "my-new-title"
},
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Response Data
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the article |
| title | string | Article title |
| content | string | Article markdown content |
| html_content | string | Article HTML content |
| category_id | string | The ID of the parent category |
| project_version_id | string | The ID of the project version where this article is located |
| version_number | number | The latest version number of this article |
| latest_version | number | The latest version number of this article |
| public_version | number | The version number that is currently published |
| version_id | string | The ID of the latest article version (revision) |
| hidden | boolean | Indicates if the article is visible on the site |
| status | enumerated | The status of the article: 0 - Draft, 1 - InReview, 2 - Public, 3 - Published, 4 - Deleted |
| order | number | The position inside the parent category |
| protection_level | enumerated | The access required to view the article: 0 - Public, 1 - LoggedInUsers |
| authors | object[] | The list of authors that contributed to this article |
| created_at | DateTime | The date the article was created |
| modified_at | DateTime | The date the article was last modified |
| slug | string | The slug of the article |
Response > Authors
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the user |
| first_name | string | Firstname of the user |
| last_name | string | Last name of the user |
| email_id | string | Email address of the user |
| profile_logo_url | string | Profile image URL of the user |
| user_role | enumerated | 1 - Administrator, 2 - Editor, 3 - DraftWriter, 4 - Reader, 7 - Owner |
| last_login_at | DateTime | Last login date of the user |
| unique_user_name | string | Unique username of the user |
Was this article helpful?