Update Article — DevRev

This endpoint expects an object.

idstringRequiredformat: "id"

The article’s ID.

access_levelenumOptional

Allowed values: externalinternalprivatepublicrestricted

aliasesobjectOptional

applies_to_partsobjectOptional

artifactsobjectOptional

authored_byobjectOptional

content_blocksobjectOptional

custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

descriptionstringOptionalformat: "text"

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

extracted_contentobjectOptional

languagestringOptionalformat: "text"

Updates the language of the article.

notifybooleanOptional

Whether to notify the users when the article is published.

owned_byobjectOptional

parentstringOptionalformat: "id"

The updated parent directory for the article.

published_versionstringOptionalformat: "text"

Updates the the latest published version.

release_notesstringOptionalformat: "text"

Updates the release notes of the article.

reorderobjectOptional

shared_withobjectOptional

statusenumOptional

Allowed values: archiveddraftpublishedreview_needed

Status of the article.

tagsobjectOptional

titlestringOptionalformat: "text"

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

urlstringOptionalformat: "text"

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": "id" 6 }'

1 { 2 "article": { 3 "id": "id", 4 "owned_by": [ 5 { 6 "type": "dev_user", 7 "id": "id", 8 "display_id": "display_id", 9 "display_name": "display_name", 10 "display_picture": { 11 "id": "id", 12 "display_id": "display_id", 13 "file": { 14 "type": "type", 15 "name": "name", 16 "size": 1 17 } 18 }, 19 "email": "email", 20 "full_name": "full_name", 21 "state": "active" 22 }, 23 { 24 "type": "dev_user", 25 "id": "id", 26 "display_id": "display_id", 27 "display_name": "display_name", 28 "display_picture": { 29 "id": "id", 30 "display_id": "display_id", 31 "file": { 32 "type": "type", 33 "name": "name", 34 "size": 1 35 } 36 }, 37 "email": "email", 38 "full_name": "full_name", 39 "state": "active" 40 } 41 ], 42 "applies_to_parts": [ 43 { 44 "type": "capability", 45 "id": "id", 46 "name": "name", 47 "owned_by": [ 48 { 49 "type": "dev_user", 50 "id": "id", 51 "display_name": "display_name", 52 "display_picture": {}, 53 "email": "email", 54 "full_name": "full_name", 55 "state": "active" 56 }, 57 { 58 "type": "dev_user", 59 "id": "id", 60 "display_name": "display_name", 61 "display_picture": {}, 62 "email": "email", 63 "full_name": "full_name", 64 "state": "active" 65 } 66 ], 67 "display_id": "display_id" 68 }, 69 { 70 "type": "capability", 71 "id": "id", 72 "name": "name", 73 "owned_by": [ 74 { 75 "type": "dev_user", 76 "id": "id", 77 "display_name": "display_name", 78 "display_picture": {}, 79 "email": "email", 80 "full_name": "full_name", 81 "state": "active" 82 }, 83 { 84 "type": "dev_user", 85 "id": "id", 86 "display_name": "display_name", 87 "display_picture": {}, 88 "email": "email", 89 "full_name": "full_name", 90 "state": "active" 91 } 92 ], 93 "display_id": "display_id" 94 } 95 ], 96 "article_type": "article", 97 "authored_by": [ 98 { 99 "type": "dev_user", 100 "id": "id", 101 "display_id": "display_id", 102 "display_name": "display_name", 103 "display_picture": { 104 "id": "id", 105 "display_id": "display_id", 106 "file": {} 107 }, 108 "email": "email", 109 "full_name": "full_name", 110 "state": "active" 111 }, 112 { 113 "type": "dev_user", 114 "id": "id", 115 "display_id": "display_id", 116 "display_name": "display_name", 117 "display_picture": { 118 "id": "id", 119 "display_id": "display_id", 120 "file": {} 121 }, 122 "email": "email", 123 "full_name": "full_name", 124 "state": "active" 125 } 126 ], 127 "created_by": { 128 "type": "dev_user", 129 "id": "id", 130 "display_id": "display_id", 131 "display_name": "display_name", 132 "display_picture": { 133 "id": "id", 134 "display_id": "display_id", 135 "file": {} 136 }, 137 "email": "email", 138 "full_name": "full_name", 139 "state": "active" 140 }, 141 "created_date": "created_date", 142 "description": "description", 143 "display_id": "display_id", 144 "extracted_content": [ 145 { 146 "id": "id", 147 "display_id": "display_id", 148 "file": { 149 "type": "type", 150 "name": "name", 151 "size": 1 152 } 153 }, 154 { 155 "id": "id", 156 "display_id": "display_id", 157 "file": { 158 "type": "type", 159 "name": "name", 160 "size": 1 161 } 162 } 163 ], 164 "modified_by": { 165 "type": "dev_user", 166 "id": "id", 167 "display_id": "display_id", 168 "display_name": "display_name", 169 "display_picture": { 170 "id": "id", 171 "display_id": "display_id", 172 "file": {} 173 }, 174 "email": "email", 175 "full_name": "full_name", 176 "state": "active" 177 }, 178 "modified_date": "modified_date", 179 "num_downvotes": 1, 180 "num_upvotes": 1, 181 "parent": { 182 "id": "id", 183 "display_id": "display_id" 184 }, 185 "rank": "rank", 186 "resource": { 187 "artifacts": [ 188 { 189 "id": "id", 190 "display_id": "display_id", 191 "file": { 192 "type": "type", 193 "name": "name", 194 "size": 1 195 } 196 }, 197 { 198 "id": "id", 199 "display_id": "display_id", 200 "file": { 201 "type": "type", 202 "name": "name", 203 "size": 1 204 } 205 } 206 ], 207 "url": "url" 208 }, 209 "scope": { 210 "id": 1000000, 211 "label": "label", 212 "ordinal": 1000000 213 }, 214 "title": "title" 215 } 216 }

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": "id"
6	}'

1	{
2	"article": {
3	"id": "id",
4	"owned_by": [
5	{
6	"type": "dev_user",
7	"id": "id",
8	"display_id": "display_id",
9	"display_name": "display_name",
10	"display_picture": {
11	"id": "id",
12	"display_id": "display_id",
13	"file": {
14	"type": "type",
15	"name": "name",
16	"size": 1
17	}
18	},
19	"email": "email",
20	"full_name": "full_name",
21	"state": "active"
22	},
23	{
24	"type": "dev_user",
25	"id": "id",
26	"display_id": "display_id",
27	"display_name": "display_name",
28	"display_picture": {
29	"id": "id",
30	"display_id": "display_id",
31	"file": {
32	"type": "type",
33	"name": "name",
34	"size": 1
35	}
36	},
37	"email": "email",
38	"full_name": "full_name",
39	"state": "active"
40	}
41	],
42	"applies_to_parts": [
43	{
44	"type": "capability",
45	"id": "id",
46	"name": "name",
47	"owned_by": [
48	{
49	"type": "dev_user",
50	"id": "id",
51	"display_name": "display_name",
52	"display_picture": {},
53	"email": "email",
54	"full_name": "full_name",
55	"state": "active"
56	},
57	{
58	"type": "dev_user",
59	"id": "id",
60	"display_name": "display_name",
61	"display_picture": {},
62	"email": "email",
63	"full_name": "full_name",
64	"state": "active"
65	}
66	],
67	"display_id": "display_id"
68	},
69	{
70	"type": "capability",
71	"id": "id",
72	"name": "name",
73	"owned_by": [
74	{
75	"type": "dev_user",
76	"id": "id",
77	"display_name": "display_name",
78	"display_picture": {},
79	"email": "email",
80	"full_name": "full_name",
81	"state": "active"
82	},
83	{
84	"type": "dev_user",
85	"id": "id",
86	"display_name": "display_name",
87	"display_picture": {},
88	"email": "email",
89	"full_name": "full_name",
90	"state": "active"
91	}
92	],
93	"display_id": "display_id"
94	}
95	],
96	"article_type": "article",
97	"authored_by": [
98	{
99	"type": "dev_user",
100	"id": "id",
101	"display_id": "display_id",
102	"display_name": "display_name",
103	"display_picture": {
104	"id": "id",
105	"display_id": "display_id",
106	"file": {}
107	},
108	"email": "email",
109	"full_name": "full_name",
110	"state": "active"
111	},
112	{
113	"type": "dev_user",
114	"id": "id",
115	"display_id": "display_id",
116	"display_name": "display_name",
117	"display_picture": {
118	"id": "id",
119	"display_id": "display_id",
120	"file": {}
121	},
122	"email": "email",
123	"full_name": "full_name",
124	"state": "active"
125	}
126	],
127	"created_by": {
128	"type": "dev_user",
129	"id": "id",
130	"display_id": "display_id",
131	"display_name": "display_name",
132	"display_picture": {
133	"id": "id",
134	"display_id": "display_id",
135	"file": {}
136	},
137	"email": "email",
138	"full_name": "full_name",
139	"state": "active"
140	},
141	"created_date": "created_date",
142	"description": "description",
143	"display_id": "display_id",
144	"extracted_content": [
145	{
146	"id": "id",
147	"display_id": "display_id",
148	"file": {
149	"type": "type",
150	"name": "name",
151	"size": 1
152	}
153	},
154	{
155	"id": "id",
156	"display_id": "display_id",
157	"file": {
158	"type": "type",
159	"name": "name",
160	"size": 1
161	}
162	}
163	],
164	"modified_by": {
165	"type": "dev_user",
166	"id": "id",
167	"display_id": "display_id",
168	"display_name": "display_name",
169	"display_picture": {
170	"id": "id",
171	"display_id": "display_id",
172	"file": {}
173	},
174	"email": "email",
175	"full_name": "full_name",
176	"state": "active"
177	},
178	"modified_date": "modified_date",
179	"num_downvotes": 1,
180	"num_upvotes": 1,
181	"parent": {
182	"id": "id",
183	"display_id": "display_id"
184	},
185	"rank": "rank",
186	"resource": {
187	"artifacts": [
188	{
189	"id": "id",
190	"display_id": "display_id",
191	"file": {
192	"type": "type",
193	"name": "name",
194	"size": 1
195	}
196	},
197	{
198	"id": "id",
199	"display_id": "display_id",
200	"file": {
201	"type": "type",
202	"name": "name",
203	"size": 1
204	}
205	}
206	],
207	"url": "url"
208	},
209	"scope": {
210	"id": 1000000,
211	"label": "label",
212	"ordinal": 1000000
213	},
214	"title": "title"
215	}
216	}

Request

Response