Update Article (Beta) — DevRev

This endpoint expects an object.

idstringRequired

The article’s ID.

access_levelenumOptional

Allowed values: externalinternalprivatepublicrestricted

aliasesobjectOptional

applies_to_partsobjectOptional

artifactsobjectOptional

authored_byobjectOptional

content_blocksobjectOptional

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 "applies_to_parts": [ 4 { 5 "type": "product", 6 "id": "applies_to_parts", 7 "name": "applies_to_parts", 8 "owned_by": [ 9 { 10 "type": "sys_user", 11 "id": "applies_to_parts" 12 } 13 ] 14 } 15 ], 16 "id": "id", 17 "owned_by": [ 18 { 19 "type": "sys_user", 20 "id": "owned_by" 21 } 22 ], 23 "article_type": "article", 24 "authored_by": [ 25 { 26 "type": "sys_user", 27 "id": "authored_by" 28 } 29 ], 30 "created_by": { 31 "type": "sys_user", 32 "id": "created_by", 33 "display_id": "created_by", 34 "display_name": "created_by", 35 "display_picture": { 36 "id": "id" 37 }, 38 "email": "created_by", 39 "full_name": "created_by", 40 "state": "active" 41 }, 42 "created_date": "2023-01-01T12:00:00Z", 43 "description": "description", 44 "display_id": "display_id", 45 "extracted_content": [ 46 { 47 "id": "id" 48 } 49 ], 50 "modified_by": { 51 "type": "sys_user", 52 "id": "modified_by", 53 "display_id": "modified_by", 54 "display_name": "modified_by", 55 "display_picture": { 56 "id": "id" 57 }, 58 "email": "modified_by", 59 "full_name": "modified_by", 60 "state": "active" 61 }, 62 "modified_date": "2023-01-01T12:00:00Z", 63 "num_downvotes": 1, 64 "num_upvotes": 1, 65 "parent": { 66 "id": "id", 67 "display_id": "display_id" 68 }, 69 "rank": "rank", 70 "resource": { 71 "artifacts": [ 72 { 73 "id": "id" 74 } 75 ], 76 "url": "url" 77 }, 78 "scope": { 79 "id": 1000000, 80 "label": "label", 81 "ordinal": 1000000, 82 "value": { 83 "key": "value" 84 } 85 }, 86 "sync_metadata": { 87 "external_reference": "external_reference", 88 "last_sync_in": { 89 "sync_date": "2023-01-01T12:00:00Z" 90 }, 91 "last_sync_out": { 92 "sync_date": "2023-01-01T12:00:00Z" 93 }, 94 "origin_system": "origin_system" 95 }, 96 "title": "title" 97 } 98 }

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	"applies_to_parts": [
4	{
5	"type": "product",
6	"id": "applies_to_parts",
7	"name": "applies_to_parts",
8	"owned_by": [
9	{
10	"type": "sys_user",
11	"id": "applies_to_parts"
12	}
13	]
14	}
15	],
16	"id": "id",
17	"owned_by": [
18	{
19	"type": "sys_user",
20	"id": "owned_by"
21	}
22	],
23	"article_type": "article",
24	"authored_by": [
25	{
26	"type": "sys_user",
27	"id": "authored_by"
28	}
29	],
30	"created_by": {
31	"type": "sys_user",
32	"id": "created_by",
33	"display_id": "created_by",
34	"display_name": "created_by",
35	"display_picture": {
36	"id": "id"
37	},
38	"email": "created_by",
39	"full_name": "created_by",
40	"state": "active"
41	},
42	"created_date": "2023-01-01T12:00:00Z",
43	"description": "description",
44	"display_id": "display_id",
45	"extracted_content": [
46	{
47	"id": "id"
48	}
49	],
50	"modified_by": {
51	"type": "sys_user",
52	"id": "modified_by",
53	"display_id": "modified_by",
54	"display_name": "modified_by",
55	"display_picture": {
56	"id": "id"
57	},
58	"email": "modified_by",
59	"full_name": "modified_by",
60	"state": "active"
61	},
62	"modified_date": "2023-01-01T12:00:00Z",
63	"num_downvotes": 1,
64	"num_upvotes": 1,
65	"parent": {
66	"id": "id",
67	"display_id": "display_id"
68	},
69	"rank": "rank",
70	"resource": {
71	"artifacts": [
72	{
73	"id": "id"
74	}
75	],
76	"url": "url"
77	},
78	"scope": {
79	"id": 1000000,
80	"label": "label",
81	"ordinal": 1000000,
82	"value": {
83	"key": "value"
84	}
85	},
86	"sync_metadata": {
87	"external_reference": "external_reference",
88	"last_sync_in": {
89	"sync_date": "2023-01-01T12:00:00Z"
90	},
91	"last_sync_out": {
92	"sync_date": "2023-01-01T12:00:00Z"
93	},
94	"origin_system": "origin_system"
95	},
96	"title": "title"
97	}
98	}

Request

Response