Fork an article

Updated On 02 Sep 2020
1 Minute To Read
Contributors

Print
Share
Dark

Light

PUT/articles/{id}/fork

Forks an article with an id

Header

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

Route Parameters

Parameters highlighted in bold are mandatory

Parameter	Type	Description
id	string	Id of the article

Body Parameters

Parameters highlighted in bold are mandatory

Parameter	Type	Description
version_number	string	The version number to be forked
user_id	string	The id of the user that will be marked as an author of this fork
lang_code	string	Language code for multilingual

Sample Request

{
    "version_number": 1,
    "user_id": "5ae331f74e60146b233558c6",
    "lang_code": "en"
}

Response Sample

{
    "data": {
        "version_number": 2,
        "created_by": "5ae331f74e60146b233558c6",
        "created_at": "2019-02-27T17:46:21.41088Z",
        "modified_at": "2019-02-27T17:46:21.41088Z",
        "base_version": 1,
        "status": 0,
        "profile_url": "https://s.gravatar.com/avatar/1b7c898ca4afb6c3ca5b7ccf89adc5a9.png"
    },
    "extension_data": null,
    "context": null,
    "success": true,
    "errors": [],
    "warnings": [],
    "information": []
}

Response Data

Parameter	Type	Description
version_number	number	The version number of the article
created_by	string	Author name
created_at	string	The date the version was created
modified_at	datetime	Last time the version was modified
base_version	number	The version number from which this version is derived
status	number	The status of the article: 0 - Draft, 3 - Published
profile_url	string	Author profile image

Was This Article Helpful?

Table Of Contents