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

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.

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       "display_id": "display_id"
78     },
79     "resource": {
80       "artifacts": [
81         {
82           "file": {
83             "type": "type",
84             "name": "name"
85           },
86           "id": "id",
87           "display_id": "display_id"
88         },
89         {
90           "file": {
91             "type": "type",
92             "name": "name"
93           },
94           "id": "id",
95           "display_id": "display_id"
96         }
97       ],
98       "url": "url"
99     },
100     "scope": {
101       "id": 1000000,
102       "label": "label",
103       "ordinal": 1000000
104     },
105     "applies_to_parts": [
106       {
107         "type": "capability",
108         "id": "id",
109         "name": "name",
110         "owned_by": [
111           {
112             "type": "dev_user",
113             "display_picture": {
114               "file": {}
115             },
116             "id": "id",
117             "state": "active",
118             "display_name": "display_name",
119             "email": "email",
120             "full_name": "full_name"
121           },
122           {
123             "type": "dev_user",
124             "display_picture": {
125               "file": {}
126             },
127             "id": "id",
128             "state": "active",
129             "display_name": "display_name",
130             "email": "email",
131             "full_name": "full_name"
132           }
133         ],
134         "display_id": "display_id"
135       },
136       {
137         "type": "capability",
138         "id": "id",
139         "name": "name",
140         "owned_by": [
141           {
142             "type": "dev_user",
143             "display_picture": {
144               "file": {}
145             },
146             "id": "id",
147             "state": "active",
148             "display_name": "display_name",
149             "email": "email",
150             "full_name": "full_name"
151           },
152           {
153             "type": "dev_user",
154             "display_picture": {
155               "file": {}
156             },
157             "id": "id",
158             "state": "active",
159             "display_name": "display_name",
160             "email": "email",
161             "full_name": "full_name"
162           }
163         ],
164         "display_id": "display_id"
165       }
166     ],
167     "authored_by": [
168       {
169         "type": "dev_user",
170         "display_picture": {
171           "file": {
172             "type": "type",
173             "name": "name"
174           },
175           "id": "id",
176           "display_id": "display_id"
177         },
178         "id": "id",
179         "state": "active",
180         "display_id": "display_id",
181         "display_name": "display_name",
182         "email": "email",
183         "full_name": "full_name"
184       },
185       {
186         "type": "dev_user",
187         "display_picture": {
188           "file": {
189             "type": "type",
190             "name": "name"
191           },
192           "id": "id",
193           "display_id": "display_id"
194         },
195         "id": "id",
196         "state": "active",
197         "display_id": "display_id",
198         "display_name": "display_name",
199         "email": "email",
200         "full_name": "full_name"
201       }
202     ],
203     "created_date": "created_date",
204     "description": "description",
205     "display_id": "display_id",
206     "extracted_content": [
207       {
208         "file": {
209           "type": "type",
210           "name": "name"
211         },
212         "id": "id",
213         "display_id": "display_id"
214       },
215       {
216         "file": {
217           "type": "type",
218           "name": "name"
219         },
220         "id": "id",
221         "display_id": "display_id"
222       }
223     ],
224     "modified_date": "modified_date",
225     "num_downvotes": 1,
226     "num_upvotes": 1,
227     "rank": "rank",
228     "title": "title"
229   }
230 }

Get Atom

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	"display_id": "display_id"
78	},
79	"resource": {
80	"artifacts": [
81	{
82	"file": {
83	"type": "type",
84	"name": "name"
85	},
86	"id": "id",
87	"display_id": "display_id"
88	},
89	{
90	"file": {
91	"type": "type",
92	"name": "name"
93	},
94	"id": "id",
95	"display_id": "display_id"
96	}
97	],
98	"url": "url"
99	},
100	"scope": {
101	"id": 1000000,
102	"label": "label",
103	"ordinal": 1000000
104	},
105	"applies_to_parts": [
106	{
107	"type": "capability",
108	"id": "id",
109	"name": "name",
110	"owned_by": [
111	{
112	"type": "dev_user",
113	"display_picture": {
114	"file": {}
115	},
116	"id": "id",
117	"state": "active",
118	"display_name": "display_name",
119	"email": "email",
120	"full_name": "full_name"
121	},
122	{
123	"type": "dev_user",
124	"display_picture": {
125	"file": {}
126	},
127	"id": "id",
128	"state": "active",
129	"display_name": "display_name",
130	"email": "email",
131	"full_name": "full_name"
132	}
133	],
134	"display_id": "display_id"
135	},
136	{
137	"type": "capability",
138	"id": "id",
139	"name": "name",
140	"owned_by": [
141	{
142	"type": "dev_user",
143	"display_picture": {
144	"file": {}
145	},
146	"id": "id",
147	"state": "active",
148	"display_name": "display_name",
149	"email": "email",
150	"full_name": "full_name"
151	},
152	{
153	"type": "dev_user",
154	"display_picture": {
155	"file": {}
156	},
157	"id": "id",
158	"state": "active",
159	"display_name": "display_name",
160	"email": "email",
161	"full_name": "full_name"
162	}
163	],
164	"display_id": "display_id"
165	}
166	],
167	"authored_by": [
168	{
169	"type": "dev_user",
170	"display_picture": {
171	"file": {
172	"type": "type",
173	"name": "name"
174	},
175	"id": "id",
176	"display_id": "display_id"
177	},
178	"id": "id",
179	"state": "active",
180	"display_id": "display_id",
181	"display_name": "display_name",
182	"email": "email",
183	"full_name": "full_name"
184	},
185	{
186	"type": "dev_user",
187	"display_picture": {
188	"file": {
189	"type": "type",
190	"name": "name"
191	},
192	"id": "id",
193	"display_id": "display_id"
194	},
195	"id": "id",
196	"state": "active",
197	"display_id": "display_id",
198	"display_name": "display_name",
199	"email": "email",
200	"full_name": "full_name"
201	}
202	],
203	"created_date": "created_date",
204	"description": "description",
205	"display_id": "display_id",
206	"extracted_content": [
207	{
208	"file": {
209	"type": "type",
210	"name": "name"
211	},
212	"id": "id",
213	"display_id": "display_id"
214	},
215	{
216	"file": {
217	"type": "type",
218	"name": "name"
219	},
220	"id": "id",
221	"display_id": "display_id"
222	}
223	],
224	"modified_date": "modified_date",
225	"num_downvotes": 1,
226	"num_upvotes": 1,
227	"rank": "rank",
228	"title": "title"
229	}
230	}