Update Article (Beta) — 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 "sync_metadata": { 69 "external_reference": "external_reference", 70 "origin_system": "origin_system" 71 } 72 }, 73 { 74 "type": "capability", 75 "id": "id", 76 "name": "name", 77 "owned_by": [ 78 { 79 "type": "dev_user", 80 "id": "id", 81 "display_name": "display_name", 82 "display_picture": {}, 83 "email": "email", 84 "full_name": "full_name", 85 "state": "active" 86 }, 87 { 88 "type": "dev_user", 89 "id": "id", 90 "display_name": "display_name", 91 "display_picture": {}, 92 "email": "email", 93 "full_name": "full_name", 94 "state": "active" 95 } 96 ], 97 "display_id": "display_id", 98 "sync_metadata": { 99 "external_reference": "external_reference", 100 "origin_system": "origin_system" 101 } 102 } 103 ], 104 "article_type": "article", 105 "authored_by": [ 106 { 107 "type": "dev_user", 108 "id": "id", 109 "display_id": "display_id", 110 "display_name": "display_name", 111 "display_picture": { 112 "id": "id", 113 "display_id": "display_id", 114 "file": {} 115 }, 116 "email": "email", 117 "full_name": "full_name", 118 "state": "active" 119 }, 120 { 121 "type": "dev_user", 122 "id": "id", 123 "display_id": "display_id", 124 "display_name": "display_name", 125 "display_picture": { 126 "id": "id", 127 "display_id": "display_id", 128 "file": {} 129 }, 130 "email": "email", 131 "full_name": "full_name", 132 "state": "active" 133 } 134 ], 135 "created_by": { 136 "type": "dev_user", 137 "id": "id", 138 "display_id": "display_id", 139 "display_name": "display_name", 140 "display_picture": { 141 "id": "id", 142 "display_id": "display_id", 143 "file": {} 144 }, 145 "email": "email", 146 "full_name": "full_name", 147 "state": "active" 148 }, 149 "created_date": "created_date", 150 "description": "description", 151 "display_id": "display_id", 152 "extracted_content": [ 153 { 154 "id": "id", 155 "display_id": "display_id", 156 "file": { 157 "type": "type", 158 "name": "name", 159 "size": 1 160 } 161 }, 162 { 163 "id": "id", 164 "display_id": "display_id", 165 "file": { 166 "type": "type", 167 "name": "name", 168 "size": 1 169 } 170 } 171 ], 172 "modified_by": { 173 "type": "dev_user", 174 "id": "id", 175 "display_id": "display_id", 176 "display_name": "display_name", 177 "display_picture": { 178 "id": "id", 179 "display_id": "display_id", 180 "file": {} 181 }, 182 "email": "email", 183 "full_name": "full_name", 184 "state": "active" 185 }, 186 "modified_date": "modified_date", 187 "num_downvotes": 1, 188 "num_upvotes": 1, 189 "parent": { 190 "id": "id", 191 "display_id": "display_id", 192 "sync_metadata": { 193 "external_reference": "external_reference", 194 "origin_system": "origin_system" 195 } 196 }, 197 "rank": "rank", 198 "resource": { 199 "artifacts": [ 200 { 201 "id": "id", 202 "display_id": "display_id", 203 "file": { 204 "type": "type", 205 "name": "name", 206 "size": 1 207 } 208 }, 209 { 210 "id": "id", 211 "display_id": "display_id", 212 "file": { 213 "type": "type", 214 "name": "name", 215 "size": 1 216 } 217 } 218 ], 219 "url": "url" 220 }, 221 "scope": { 222 "id": 1000000, 223 "label": "label", 224 "ordinal": 1000000 225 }, 226 "sync_metadata": { 227 "external_reference": "external_reference", 228 "last_sync_in": { 229 "status": "failed", 230 "sync_date": "sync_date", 231 "sync_unit": { 232 "id": "id", 233 "display_id": "display_id", 234 "external_system_type": "adaas", 235 "is_archived": true, 236 "name": "name", 237 "sync_run": {}, 238 "sync_type": "manual" 239 } 240 }, 241 "last_sync_out": { 242 "status": "failed", 243 "sync_date": "sync_date", 244 "sync_unit": { 245 "id": "id", 246 "display_id": "display_id", 247 "external_system_type": "adaas", 248 "is_archived": true, 249 "name": "name", 250 "sync_run": {}, 251 "sync_type": "manual" 252 } 253 }, 254 "origin_system": "origin_system" 255 }, 256 "title": "title" 257 } 258 }

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	"sync_metadata": {
69	"external_reference": "external_reference",
70	"origin_system": "origin_system"
71	}
72	},
73	{
74	"type": "capability",
75	"id": "id",
76	"name": "name",
77	"owned_by": [
78	{
79	"type": "dev_user",
80	"id": "id",
81	"display_name": "display_name",
82	"display_picture": {},
83	"email": "email",
84	"full_name": "full_name",
85	"state": "active"
86	},
87	{
88	"type": "dev_user",
89	"id": "id",
90	"display_name": "display_name",
91	"display_picture": {},
92	"email": "email",
93	"full_name": "full_name",
94	"state": "active"
95	}
96	],
97	"display_id": "display_id",
98	"sync_metadata": {
99	"external_reference": "external_reference",
100	"origin_system": "origin_system"
101	}
102	}
103	],
104	"article_type": "article",
105	"authored_by": [
106	{
107	"type": "dev_user",
108	"id": "id",
109	"display_id": "display_id",
110	"display_name": "display_name",
111	"display_picture": {
112	"id": "id",
113	"display_id": "display_id",
114	"file": {}
115	},
116	"email": "email",
117	"full_name": "full_name",
118	"state": "active"
119	},
120	{
121	"type": "dev_user",
122	"id": "id",
123	"display_id": "display_id",
124	"display_name": "display_name",
125	"display_picture": {
126	"id": "id",
127	"display_id": "display_id",
128	"file": {}
129	},
130	"email": "email",
131	"full_name": "full_name",
132	"state": "active"
133	}
134	],
135	"created_by": {
136	"type": "dev_user",
137	"id": "id",
138	"display_id": "display_id",
139	"display_name": "display_name",
140	"display_picture": {
141	"id": "id",
142	"display_id": "display_id",
143	"file": {}
144	},
145	"email": "email",
146	"full_name": "full_name",
147	"state": "active"
148	},
149	"created_date": "created_date",
150	"description": "description",
151	"display_id": "display_id",
152	"extracted_content": [
153	{
154	"id": "id",
155	"display_id": "display_id",
156	"file": {
157	"type": "type",
158	"name": "name",
159	"size": 1
160	}
161	},
162	{
163	"id": "id",
164	"display_id": "display_id",
165	"file": {
166	"type": "type",
167	"name": "name",
168	"size": 1
169	}
170	}
171	],
172	"modified_by": {
173	"type": "dev_user",
174	"id": "id",
175	"display_id": "display_id",
176	"display_name": "display_name",
177	"display_picture": {
178	"id": "id",
179	"display_id": "display_id",
180	"file": {}
181	},
182	"email": "email",
183	"full_name": "full_name",
184	"state": "active"
185	},
186	"modified_date": "modified_date",
187	"num_downvotes": 1,
188	"num_upvotes": 1,
189	"parent": {
190	"id": "id",
191	"display_id": "display_id",
192	"sync_metadata": {
193	"external_reference": "external_reference",
194	"origin_system": "origin_system"
195	}
196	},
197	"rank": "rank",
198	"resource": {
199	"artifacts": [
200	{
201	"id": "id",
202	"display_id": "display_id",
203	"file": {
204	"type": "type",
205	"name": "name",
206	"size": 1
207	}
208	},
209	{
210	"id": "id",
211	"display_id": "display_id",
212	"file": {
213	"type": "type",
214	"name": "name",
215	"size": 1
216	}
217	}
218	],
219	"url": "url"
220	},
221	"scope": {
222	"id": 1000000,
223	"label": "label",
224	"ordinal": 1000000
225	},
226	"sync_metadata": {
227	"external_reference": "external_reference",
228	"last_sync_in": {
229	"status": "failed",
230	"sync_date": "sync_date",
231	"sync_unit": {
232	"id": "id",
233	"display_id": "display_id",
234	"external_system_type": "adaas",
235	"is_archived": true,
236	"name": "name",
237	"sync_run": {},
238	"sync_type": "manual"
239	}
240	},
241	"last_sync_out": {
242	"status": "failed",
243	"sync_date": "sync_date",
244	"sync_unit": {
245	"id": "id",
246	"display_id": "display_id",
247	"external_system_type": "adaas",
248	"is_archived": true,
249	"name": "name",
250	"sync_run": {},
251	"sync_type": "manual"
252	}
253	},
254	"origin_system": "origin_system"
255	},
256	"title": "title"
257	}
258	}

Request

Response