Update Article — DevRev

This endpoint expects an object.

idstringRequired

The article's ID.

access_levelenumOptional

Allowed values: externalinternalprivatepublicrestricted

applies_to_partsobjectOptional

artifactsobjectOptional

authored_byobjectOptional

custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema's custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

descriptionstringOptional

Updated description of the article object, or unchanged if not provided.

extracted_contentobjectOptional

languagestringOptional

Updates the language of the article.

owned_byobjectOptional

parentstringOptional

The updated parent directory for the article.

published_versionstringOptional

Updates the the latest published version.

reorderobjectOptional

shared_withobjectOptional

statusenumOptional

Allowed values: archiveddraftpublishedreview_needed

Status of the article.

tagsobjectOptional

titlestringOptional

Updated title of the article object, or unchanged if not provided.

urlstringOptional

Updates the URL of the external article.

1 curl -X POST https://api.devrev.ai/articles.update \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "id": "ARTICLE-12345" 6 }'

1 { 2 "article": { 3 "created_date": "2023-01-01T12:00:00Z", 4 "display_id": "display_id", 5 "id": "id", 6 "modified_date": "2023-01-01T12:00:00Z", 7 "applies_to_parts": [], 8 "article_type": "article", 9 "description": "description", 10 "extracted_content": [ 11 { 12 "id": "id" 13 } 14 ], 15 "num_downvotes": 1, 16 "num_upvotes": 1, 17 "owned_by": [], 18 "parent": { 19 "display_id": "display_id", 20 "id": "id" 21 }, 22 "rank": "rank", 23 "resource": { 24 "artifacts": [ 25 { 26 "id": "id" 27 } 28 ], 29 "url": "url" 30 }, 31 "scope": { 32 "id": 1000000, 33 "label": "label", 34 "ordinal": 1000000 35 }, 36 "title": "title" 37 } 38 }

1	curl -X POST https://api.devrev.ai/articles.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"id": "ARTICLE-12345"
6	}'

1	{
2	"article": {
3	"created_date": "2023-01-01T12:00:00Z",
4	"display_id": "display_id",
5	"id": "id",
6	"modified_date": "2023-01-01T12:00:00Z",
7	"applies_to_parts": [],
8	"article_type": "article",
9	"description": "description",
10	"extracted_content": [
11	{
12	"id": "id"
13	}
14	],
15	"num_downvotes": 1,
16	"num_upvotes": 1,
17	"owned_by": [],
18	"parent": {
19	"display_id": "display_id",
20	"id": "id"
21	},
22	"rank": "rank",
23	"resource": {
24	"artifacts": [
25	{
26	"id": "id"
27	}
28	],
29	"url": "url"
30	},
31	"scope": {
32	"id": 1000000,
33	"label": "label",
34	"ordinal": 1000000
35	},
36	"title": "title"
37	}
38	}

Request

Response