Update Article

POST

Updates an article.

Request

This endpoint expects an object.

access_levelenumRequired

Allowed values: externalinternalprivatepublicrestricted

aliasesobjectRequired

applies_to_partsobjectRequired

artifactsobjectRequired

authored_byobjectRequired

content_blocksobjectRequired

custom_schema_specobjectRequired

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.

extracted_contentobjectRequired

idstringRequiredformat: "id"

The article’s ID.

owned_byobjectRequired

reorderobjectRequired

shared_withobjectRequired

statusenumRequired

Allowed values: archiveddraftpublishedreview_needed

Status of the article.

tagsobjectRequired

custom_fieldsobjectOptional

Application-defined custom fields.

descriptionstringOptionalformat: "text"

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

languagestringOptionalformat: "text"

Updates the language of the article.

parentstringOptionalformat: "id"

The updated parent directory for the article.

published_versionstringOptionalformat: "text"

Updates the the latest published version.

titlestringOptionalformat: "text"

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

urlstringOptionalformat: "text"

Updates the URL of the external article.

Response

Success.

articleobject

POST

1 curl -X POST https://api.devrev.ai/articles.update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "access_level": "external",
6   "aliases": {
7     "set": [
8       "set",
9       "set"
10     ]
11   },
12   "applies_to_parts": {},
13   "artifacts": {},
14   "authored_by": {},
15   "content_blocks": {
16     "set": [
17       "set",
18       "set"
19     ]
20   },
21   "custom_schema_spec": {},
22   "extracted_content": {},
23   "id": "id",
24   "owned_by": {},
25   "reorder": {},
26   "shared_with": {},
27   "status": "archived",
28   "tags": {}
29 }'

200Successful

1 {
2   "article": {
3     "article_type": "article",
4     "created_by": {
5       "type": "dev_user",
6       "display_picture": {
7         "file": {
8           "type": "type",
9           "name": "name"
10         },
11         "id": "id",
12         "display_id": "display_id"
13       },
14       "id": "id",
15       "state": "active",
16       "display_id": "display_id",
17       "display_name": "display_name",
18       "email": "email",
19       "full_name": "full_name"
20     },
21     "id": "id",
22     "modified_by": {
23       "type": "dev_user",
24       "display_picture": {
25         "file": {
26           "type": "type",
27           "name": "name"
28         },
29         "id": "id",
30         "display_id": "display_id"
31       },
32       "id": "id",
33       "state": "active",
34       "display_id": "display_id",
35       "display_name": "display_name",
36       "email": "email",
37       "full_name": "full_name"
38     },
39     "owned_by": [
40       {
41         "type": "dev_user",
42         "display_picture": {
43           "file": {
44             "type": "type",
45             "name": "name"
46           },
47           "id": "id",
48           "display_id": "display_id"
49         },
50         "id": "id",
51         "state": "active",
52         "display_id": "display_id",
53         "display_name": "display_name",
54         "email": "email",
55         "full_name": "full_name"
56       },
57       {
58         "type": "dev_user",
59         "display_picture": {
60           "file": {
61             "type": "type",
62             "name": "name"
63           },
64           "id": "id",
65           "display_id": "display_id"
66         },
67         "id": "id",
68         "state": "active",
69         "display_id": "display_id",
70         "display_name": "display_name",
71         "email": "email",
72         "full_name": "full_name"
73       }
74     ],
75     "parent": {
76       "id": "id",
77       "sync_metadata": {
78         "external_reference": "external_reference",
79         "origin_system": "origin_system"
80       },
81       "display_id": "display_id"
82     },
83     "resource": {
84       "artifacts": [
85         {
86           "file": {
87             "type": "type",
88             "name": "name"
89           },
90           "id": "id",
91           "display_id": "display_id"
92         },
93         {
94           "file": {
95             "type": "type",
96             "name": "name"
97           },
98           "id": "id",
99           "display_id": "display_id"
100         }
101       ],
102       "url": "url"
103     },
104     "scope": {
105       "id": 1000000,
106       "label": "label",
107       "ordinal": 1000000
108     },
109     "sync_metadata": {
110       "last_sync_in": {
111         "status": "failed",
112         "sync_unit": {
113           "external_system_type": "adaas",
114           "id": "id",
115           "sync_run": {
116             "mode": "initial",
117             "progress": {
118               "state": "completed"
119             }
120           },
121           "sync_type": "manual",
122           "display_id": "display_id",
123           "is_archived": true,
124           "name": "name"
125         },
126         "sync_date": "sync_date"
127       },
128       "last_sync_out": {
129         "status": "failed",
130         "sync_unit": {
131           "external_system_type": "adaas",
132           "id": "id",
133           "sync_run": {
134             "mode": "initial",
135             "progress": {
136               "state": "completed"
137             }
138           },
139           "sync_type": "manual",
140           "display_id": "display_id",
141           "is_archived": true,
142           "name": "name"
143         },
144         "sync_date": "sync_date"
145       },
146       "external_reference": "external_reference",
147       "origin_system": "origin_system"
148     },
149     "applies_to_parts": [
150       {
151         "type": "capability",
152         "id": "id",
153         "name": "name",
154         "owned_by": [
155           {
156             "type": "dev_user",
157             "display_picture": {
158               "file": {}
159             },
160             "id": "id",
161             "state": "active",
162             "display_name": "display_name",
163             "email": "email",
164             "full_name": "full_name"
165           },
166           {
167             "type": "dev_user",
168             "display_picture": {
169               "file": {}
170             },
171             "id": "id",
172             "state": "active",
173             "display_name": "display_name",
174             "email": "email",
175             "full_name": "full_name"
176           }
177         ],
178         "sync_metadata": {
179           "external_reference": "external_reference",
180           "origin_system": "origin_system"
181         },
182         "display_id": "display_id"
183       },
184       {
185         "type": "capability",
186         "id": "id",
187         "name": "name",
188         "owned_by": [
189           {
190             "type": "dev_user",
191             "display_picture": {
192               "file": {}
193             },
194             "id": "id",
195             "state": "active",
196             "display_name": "display_name",
197             "email": "email",
198             "full_name": "full_name"
199           },
200           {
201             "type": "dev_user",
202             "display_picture": {
203               "file": {}
204             },
205             "id": "id",
206             "state": "active",
207             "display_name": "display_name",
208             "email": "email",
209             "full_name": "full_name"
210           }
211         ],
212         "sync_metadata": {
213           "external_reference": "external_reference",
214           "origin_system": "origin_system"
215         },
216         "display_id": "display_id"
217       }
218     ],
219     "authored_by": [
220       {
221         "type": "dev_user",
222         "display_picture": {
223           "file": {
224             "type": "type",
225             "name": "name"
226           },
227           "id": "id",
228           "display_id": "display_id"
229         },
230         "id": "id",
231         "state": "active",
232         "display_id": "display_id",
233         "display_name": "display_name",
234         "email": "email",
235         "full_name": "full_name"
236       },
237       {
238         "type": "dev_user",
239         "display_picture": {
240           "file": {
241             "type": "type",
242             "name": "name"
243           },
244           "id": "id",
245           "display_id": "display_id"
246         },
247         "id": "id",
248         "state": "active",
249         "display_id": "display_id",
250         "display_name": "display_name",
251         "email": "email",
252         "full_name": "full_name"
253       }
254     ],
255     "created_date": "created_date",
256     "description": "description",
257     "display_id": "display_id",
258     "extracted_content": [
259       {
260         "file": {
261           "type": "type",
262           "name": "name"
263         },
264         "id": "id",
265         "display_id": "display_id"
266       },
267       {
268         "file": {
269           "type": "type",
270           "name": "name"
271         },
272         "id": "id",
273         "display_id": "display_id"
274       }
275     ],
276     "modified_date": "modified_date",
277     "num_downvotes": 1,
278     "num_upvotes": 1,
279     "rank": "rank",
280     "title": "title"
281   }
282 }

Get Artifact

Up Next

Built with

1	curl -X POST https://api.devrev.ai/articles.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"access_level": "external",
6	"aliases": {
7	"set": [
8	"set",
9	"set"
10	]
11	},
12	"applies_to_parts": {},
13	"artifacts": {},
14	"authored_by": {},
15	"content_blocks": {
16	"set": [
17	"set",
18	"set"
19	]
20	},
21	"custom_schema_spec": {},
22	"extracted_content": {},
23	"id": "id",
24	"owned_by": {},
25	"reorder": {},
26	"shared_with": {},
27	"status": "archived",
28	"tags": {}
29	}'

1	{
2	"article": {
3	"article_type": "article",
4	"created_by": {
5	"type": "dev_user",
6	"display_picture": {
7	"file": {
8	"type": "type",
9	"name": "name"
10	},
11	"id": "id",
12	"display_id": "display_id"
13	},
14	"id": "id",
15	"state": "active",
16	"display_id": "display_id",
17	"display_name": "display_name",
18	"email": "email",
19	"full_name": "full_name"
20	},
21	"id": "id",
22	"modified_by": {
23	"type": "dev_user",
24	"display_picture": {
25	"file": {
26	"type": "type",
27	"name": "name"
28	},
29	"id": "id",
30	"display_id": "display_id"
31	},
32	"id": "id",
33	"state": "active",
34	"display_id": "display_id",
35	"display_name": "display_name",
36	"email": "email",
37	"full_name": "full_name"
38	},
39	"owned_by": [
40	{
41	"type": "dev_user",
42	"display_picture": {
43	"file": {
44	"type": "type",
45	"name": "name"
46	},
47	"id": "id",
48	"display_id": "display_id"
49	},
50	"id": "id",
51	"state": "active",
52	"display_id": "display_id",
53	"display_name": "display_name",
54	"email": "email",
55	"full_name": "full_name"
56	},
57	{
58	"type": "dev_user",
59	"display_picture": {
60	"file": {
61	"type": "type",
62	"name": "name"
63	},
64	"id": "id",
65	"display_id": "display_id"
66	},
67	"id": "id",
68	"state": "active",
69	"display_id": "display_id",
70	"display_name": "display_name",
71	"email": "email",
72	"full_name": "full_name"
73	}
74	],
75	"parent": {
76	"id": "id",
77	"sync_metadata": {
78	"external_reference": "external_reference",
79	"origin_system": "origin_system"
80	},
81	"display_id": "display_id"
82	},
83	"resource": {
84	"artifacts": [
85	{
86	"file": {
87	"type": "type",
88	"name": "name"
89	},
90	"id": "id",
91	"display_id": "display_id"
92	},
93	{
94	"file": {
95	"type": "type",
96	"name": "name"
97	},
98	"id": "id",
99	"display_id": "display_id"
100	}
101	],
102	"url": "url"
103	},
104	"scope": {
105	"id": 1000000,
106	"label": "label",
107	"ordinal": 1000000
108	},
109	"sync_metadata": {
110	"last_sync_in": {
111	"status": "failed",
112	"sync_unit": {
113	"external_system_type": "adaas",
114	"id": "id",
115	"sync_run": {
116	"mode": "initial",
117	"progress": {
118	"state": "completed"
119	}
120	},
121	"sync_type": "manual",
122	"display_id": "display_id",
123	"is_archived": true,
124	"name": "name"
125	},
126	"sync_date": "sync_date"
127	},
128	"last_sync_out": {
129	"status": "failed",
130	"sync_unit": {
131	"external_system_type": "adaas",
132	"id": "id",
133	"sync_run": {
134	"mode": "initial",
135	"progress": {
136	"state": "completed"
137	}
138	},
139	"sync_type": "manual",
140	"display_id": "display_id",
141	"is_archived": true,
142	"name": "name"
143	},
144	"sync_date": "sync_date"
145	},
146	"external_reference": "external_reference",
147	"origin_system": "origin_system"
148	},
149	"applies_to_parts": [
150	{
151	"type": "capability",
152	"id": "id",
153	"name": "name",
154	"owned_by": [
155	{
156	"type": "dev_user",
157	"display_picture": {
158	"file": {}
159	},
160	"id": "id",
161	"state": "active",
162	"display_name": "display_name",
163	"email": "email",
164	"full_name": "full_name"
165	},
166	{
167	"type": "dev_user",
168	"display_picture": {
169	"file": {}
170	},
171	"id": "id",
172	"state": "active",
173	"display_name": "display_name",
174	"email": "email",
175	"full_name": "full_name"
176	}
177	],
178	"sync_metadata": {
179	"external_reference": "external_reference",
180	"origin_system": "origin_system"
181	},
182	"display_id": "display_id"
183	},
184	{
185	"type": "capability",
186	"id": "id",
187	"name": "name",
188	"owned_by": [
189	{
190	"type": "dev_user",
191	"display_picture": {
192	"file": {}
193	},
194	"id": "id",
195	"state": "active",
196	"display_name": "display_name",
197	"email": "email",
198	"full_name": "full_name"
199	},
200	{
201	"type": "dev_user",
202	"display_picture": {
203	"file": {}
204	},
205	"id": "id",
206	"state": "active",
207	"display_name": "display_name",
208	"email": "email",
209	"full_name": "full_name"
210	}
211	],
212	"sync_metadata": {
213	"external_reference": "external_reference",
214	"origin_system": "origin_system"
215	},
216	"display_id": "display_id"
217	}
218	],
219	"authored_by": [
220	{
221	"type": "dev_user",
222	"display_picture": {
223	"file": {
224	"type": "type",
225	"name": "name"
226	},
227	"id": "id",
228	"display_id": "display_id"
229	},
230	"id": "id",
231	"state": "active",
232	"display_id": "display_id",
233	"display_name": "display_name",
234	"email": "email",
235	"full_name": "full_name"
236	},
237	{
238	"type": "dev_user",
239	"display_picture": {
240	"file": {
241	"type": "type",
242	"name": "name"
243	},
244	"id": "id",
245	"display_id": "display_id"
246	},
247	"id": "id",
248	"state": "active",
249	"display_id": "display_id",
250	"display_name": "display_name",
251	"email": "email",
252	"full_name": "full_name"
253	}
254	],
255	"created_date": "created_date",
256	"description": "description",
257	"display_id": "display_id",
258	"extracted_content": [
259	{
260	"file": {
261	"type": "type",
262	"name": "name"
263	},
264	"id": "id",
265	"display_id": "display_id"
266	},
267	{
268	"file": {
269	"type": "type",
270	"name": "name"
271	},
272	"id": "id",
273	"display_id": "display_id"
274	}
275	],
276	"modified_date": "modified_date",
277	"num_downvotes": 1,
278	"num_upvotes": 1,
279	"rank": "rank",
280	"title": "title"
281	}
282	}