Fork an article
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Fork an article
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
PUT /articles/{id}/fork
Forks an article with an ID
Header
| Parameter | Type | Description |
|---|---|---|
| api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Route Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | Yes | string | ID of the article |
Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| version_number | Yes | string | The version number to be forked |
| user_id | Yes | string | The ID of the user that will be marked as an author of this fork |
| lang_code | Yes | 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 this version was created |
| modified_at | DateTime | The 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?