Update Article

POST

Updates an article.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The article’s ID.

access_levelenumOptional

Allowed values: externalinternalprivatepublicrestricted

aliasesobjectOptional

applies_to_partsobjectOptional

artifactsobjectOptional

authored_byobjectOptional

brandstringOptionalformat: "id"

The updated brand of the article.

content_blocksobjectOptional

content_formatenumOptional

Allowed values: drdfv2rt

Content format of the article.

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.

data_sourcesobjectOptional

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.

Response

Success.

articleobject

Errors

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

200articlesUpdateArticleExample

1 {
2   "article": {
3     "id": "foo",
4     "owned_by": [
5       {
6         "display_id": "foo",
7         "id": "foo",
8         "display_name": "foo",
9         "display_picture": {
10           "display_id": "foo",
11           "id": "foo",
12           "file": {
13             "type": "foo",
14             "name": "foo",
15             "size": 42
16           }
17         },
18         "email": "foo",
19         "full_name": "foo",
20         "state": "active"
21       }
22     ],
23     "applies_to_parts": [
24       {
25         "display_id": "foo",
26         "id": "foo",
27         "name": "foo",
28         "owned_by": [
29           {}
30         ],
31         "sync_metadata": {
32           "external_reference": "foo",
33           "origin_system": "foo"
34         }
35       }
36     ],
37     "article_type": "article",
38     "authored_by": [
39       {
40         "display_id": "foo",
41         "id": "foo",
42         "display_name": "foo",
43         "display_picture": {
44           "display_id": "foo",
45           "id": "foo",
46           "file": {
47             "type": "foo",
48             "name": "foo",
49             "size": 42
50           }
51         },
52         "email": "foo",
53         "full_name": "foo",
54         "state": "active"
55       }
56     ],
57     "created_by": {
58       "display_id": "foo",
59       "id": "foo",
60       "display_name": "foo",
61       "display_picture": {
62         "display_id": "foo",
63         "id": "foo",
64         "file": {
65           "type": "foo",
66           "name": "foo",
67           "size": 42
68         }
69       },
70       "email": "foo",
71       "full_name": "foo",
72       "state": "active"
73     },
74     "created_date": "2023-01-01T12:00:00.000Z",
75     "description": "foo",
76     "display_id": "foo",
77     "extracted_content": [
78       {
79         "id": "foo",
80         "display_id": "foo",
81         "file": {
82           "type": "foo",
83           "name": "foo",
84           "size": 42
85         }
86       }
87     ],
88     "modified_by": {
89       "display_id": "foo",
90       "id": "foo",
91       "display_name": "foo",
92       "display_picture": {
93         "display_id": "foo",
94         "id": "foo",
95         "file": {
96           "type": "foo",
97           "name": "foo",
98           "size": 42
99         }
100       },
101       "email": "foo",
102       "full_name": "foo",
103       "state": "active"
104     },
105     "modified_date": "2023-01-01T12:00:00.000Z",
106     "num_downvotes": 42,
107     "num_upvotes": 42,
108     "parent": {
109       "id": "foo",
110       "display_id": "foo",
111       "sync_metadata": {
112         "external_reference": "foo",
113         "origin_system": "foo"
114       }
115     },
116     "rank": "foo",
117     "resource": {
118       "artifacts": [
119         {
120           "id": "foo",
121           "display_id": "foo",
122           "file": {
123             "type": "foo",
124             "name": "foo",
125             "size": 42
126           }
127         }
128       ],
129       "url": "foo"
130     },
131     "scope": {
132       "id": 42,
133       "label": "foo",
134       "ordinal": 42,
135       "value": null
136     },
137     "sync_metadata": {
138       "external_reference": "foo",
139       "last_sync_in": {
140         "status": "failed",
141         "sync_date": "2023-01-01T12:00:00.000Z",
142         "sync_unit": {
143           "id": "foo",
144           "display_id": "foo",
145           "external_system_type": "adaas",
146           "is_archived": true,
147           "name": "foo",
148           "sync_run": {
149             "mode": "initial",
150             "progress": {
151               "state": "completed"
152             }
153           },
154           "sync_type": "manual"
155         }
156       },
157       "last_sync_out": {
158         "status": "failed",
159         "sync_date": "2023-01-01T12:00:00.000Z",
160         "sync_unit": {
161           "id": "foo",
162           "display_id": "foo",
163           "external_system_type": "adaas",
164           "is_archived": true,
165           "name": "foo",
166           "sync_run": {
167             "mode": "initial",
168             "progress": {
169               "state": "completed"
170             }
171           },
172           "sync_type": "manual"
173         }
174       },
175       "origin_system": "foo"
176     },
177     "title": "foo"
178   }
179 }

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

1	{
2	"article": {
3	"id": "foo",
4	"owned_by": [
5	{
6	"display_id": "foo",
7	"id": "foo",
8	"display_name": "foo",
9	"display_picture": {
10	"display_id": "foo",
11	"id": "foo",
12	"file": {
13	"type": "foo",
14	"name": "foo",
15	"size": 42
16	}
17	},
18	"email": "foo",
19	"full_name": "foo",
20	"state": "active"
21	}
22	],
23	"applies_to_parts": [
24	{
25	"display_id": "foo",
26	"id": "foo",
27	"name": "foo",
28	"owned_by": [
29	{}
30	],
31	"sync_metadata": {
32	"external_reference": "foo",
33	"origin_system": "foo"
34	}
35	}
36	],
37	"article_type": "article",
38	"authored_by": [
39	{
40	"display_id": "foo",
41	"id": "foo",
42	"display_name": "foo",
43	"display_picture": {
44	"display_id": "foo",
45	"id": "foo",
46	"file": {
47	"type": "foo",
48	"name": "foo",
49	"size": 42
50	}
51	},
52	"email": "foo",
53	"full_name": "foo",
54	"state": "active"
55	}
56	],
57	"created_by": {
58	"display_id": "foo",
59	"id": "foo",
60	"display_name": "foo",
61	"display_picture": {
62	"display_id": "foo",
63	"id": "foo",
64	"file": {
65	"type": "foo",
66	"name": "foo",
67	"size": 42
68	}
69	},
70	"email": "foo",
71	"full_name": "foo",
72	"state": "active"
73	},
74	"created_date": "2023-01-01T12:00:00.000Z",
75	"description": "foo",
76	"display_id": "foo",
77	"extracted_content": [
78	{
79	"id": "foo",
80	"display_id": "foo",
81	"file": {
82	"type": "foo",
83	"name": "foo",
84	"size": 42
85	}
86	}
87	],
88	"modified_by": {
89	"display_id": "foo",
90	"id": "foo",
91	"display_name": "foo",
92	"display_picture": {
93	"display_id": "foo",
94	"id": "foo",
95	"file": {
96	"type": "foo",
97	"name": "foo",
98	"size": 42
99	}
100	},
101	"email": "foo",
102	"full_name": "foo",
103	"state": "active"
104	},
105	"modified_date": "2023-01-01T12:00:00.000Z",
106	"num_downvotes": 42,
107	"num_upvotes": 42,
108	"parent": {
109	"id": "foo",
110	"display_id": "foo",
111	"sync_metadata": {
112	"external_reference": "foo",
113	"origin_system": "foo"
114	}
115	},
116	"rank": "foo",
117	"resource": {
118	"artifacts": [
119	{
120	"id": "foo",
121	"display_id": "foo",
122	"file": {
123	"type": "foo",
124	"name": "foo",
125	"size": 42
126	}
127	}
128	],
129	"url": "foo"
130	},
131	"scope": {
132	"id": 42,
133	"label": "foo",
134	"ordinal": 42,
135	"value": null
136	},
137	"sync_metadata": {
138	"external_reference": "foo",
139	"last_sync_in": {
140	"status": "failed",
141	"sync_date": "2023-01-01T12:00:00.000Z",
142	"sync_unit": {
143	"id": "foo",
144	"display_id": "foo",
145	"external_system_type": "adaas",
146	"is_archived": true,
147	"name": "foo",
148	"sync_run": {
149	"mode": "initial",
150	"progress": {
151	"state": "completed"
152	}
153	},
154	"sync_type": "manual"
155	}
156	},
157	"last_sync_out": {
158	"status": "failed",
159	"sync_date": "2023-01-01T12:00:00.000Z",
160	"sync_unit": {
161	"id": "foo",
162	"display_id": "foo",
163	"external_system_type": "adaas",
164	"is_archived": true,
165	"name": "foo",
166	"sync_run": {
167	"mode": "initial",
168	"progress": {
169	"state": "completed"
170	}
171	},
172	"sync_type": "manual"
173	}
174	},
175	"origin_system": "foo"
176	},
177	"title": "foo"
178	}
179	}