Update an article

Updated On 02 Sep 2020
2 Minutes To Read
Contributors

Print
Share
Dark

Light

PUT/articles/{id}/{langcode}

Updates an article with the ID

Header

Parameter	Type	Description
api_token	string	REST API key you can get it from Settings > API.

Route Parameter

Parameters highlighted in bold are mandatory

Parameter	Type	Description
id	string	ID of the article
langcode	string	Language code for multilingual

Body Parameters

Parameters highlighted in bold are mandatory

Parameter	Type	Description
title	string	New article title
content	string	New article markdown content
content	string	New article markdown content
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 - Need 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	ID of the article
title	string	Article title
content	string	Article markdown cotent
html_content	string	Article html content
category_id	string	The id of the parent category
project_version_id	string	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 latest article version
hidden	boolean	Indicates if article is visible in 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 requried 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	ID of the user
first_name	string	Firstname of the user
last_name	string	Lastname 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?

Table Of Contents