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       }
32     ],
33     "article_type": "article",
34     "authored_by": [
35       {
36         "display_id": "foo",
37         "id": "foo",
38         "display_name": "foo",
39         "display_picture": {
40           "display_id": "foo",
41           "id": "foo",
42           "file": {
43             "type": "foo",
44             "name": "foo",
45             "size": 42
46           }
47         },
48         "email": "foo",
49         "full_name": "foo",
50         "state": "active"
51       }
52     ],
53     "created_by": {
54       "display_id": "foo",
55       "id": "foo",
56       "display_name": "foo",
57       "display_picture": {
58         "display_id": "foo",
59         "id": "foo",
60         "file": {
61           "type": "foo",
62           "name": "foo",
63           "size": 42
64         }
65       },
66       "email": "foo",
67       "full_name": "foo",
68       "state": "active"
69     },
70     "created_date": "2023-01-01T12:00:00.000Z",
71     "description": "foo",
72     "display_id": "foo",
73     "extracted_content": [
74       {
75         "id": "foo",
76         "display_id": "foo",
77         "file": {
78           "type": "foo",
79           "name": "foo",
80           "size": 42
81         }
82       }
83     ],
84     "modified_by": {
85       "display_id": "foo",
86       "id": "foo",
87       "display_name": "foo",
88       "display_picture": {
89         "display_id": "foo",
90         "id": "foo",
91         "file": {
92           "type": "foo",
93           "name": "foo",
94           "size": 42
95         }
96       },
97       "email": "foo",
98       "full_name": "foo",
99       "state": "active"
100     },
101     "modified_date": "2023-01-01T12:00:00.000Z",
102     "num_downvotes": 42,
103     "num_upvotes": 42,
104     "parent": {
105       "id": "foo",
106       "display_id": "foo"
107     },
108     "rank": "foo",
109     "resource": {
110       "artifacts": [
111         {
112           "id": "foo",
113           "display_id": "foo",
114           "file": {
115             "type": "foo",
116             "name": "foo",
117             "size": 42
118           }
119         }
120       ],
121       "url": "foo"
122     },
123     "scope": {
124       "id": 42,
125       "label": "foo",
126       "ordinal": 42,
127       "value": null
128     },
129     "title": "foo"
130   }
131 }

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	"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	}
32	],
33	"article_type": "article",
34	"authored_by": [
35	{
36	"display_id": "foo",
37	"id": "foo",
38	"display_name": "foo",
39	"display_picture": {
40	"display_id": "foo",
41	"id": "foo",
42	"file": {
43	"type": "foo",
44	"name": "foo",
45	"size": 42
46	}
47	},
48	"email": "foo",
49	"full_name": "foo",
50	"state": "active"
51	}
52	],
53	"created_by": {
54	"display_id": "foo",
55	"id": "foo",
56	"display_name": "foo",
57	"display_picture": {
58	"display_id": "foo",
59	"id": "foo",
60	"file": {
61	"type": "foo",
62	"name": "foo",
63	"size": 42
64	}
65	},
66	"email": "foo",
67	"full_name": "foo",
68	"state": "active"
69	},
70	"created_date": "2023-01-01T12:00:00.000Z",
71	"description": "foo",
72	"display_id": "foo",
73	"extracted_content": [
74	{
75	"id": "foo",
76	"display_id": "foo",
77	"file": {
78	"type": "foo",
79	"name": "foo",
80	"size": 42
81	}
82	}
83	],
84	"modified_by": {
85	"display_id": "foo",
86	"id": "foo",
87	"display_name": "foo",
88	"display_picture": {
89	"display_id": "foo",
90	"id": "foo",
91	"file": {
92	"type": "foo",
93	"name": "foo",
94	"size": 42
95	}
96	},
97	"email": "foo",
98	"full_name": "foo",
99	"state": "active"
100	},
101	"modified_date": "2023-01-01T12:00:00.000Z",
102	"num_downvotes": 42,
103	"num_upvotes": 42,
104	"parent": {
105	"id": "foo",
106	"display_id": "foo"
107	},
108	"rank": "foo",
109	"resource": {
110	"artifacts": [
111	{
112	"id": "foo",
113	"display_id": "foo",
114	"file": {
115	"type": "foo",
116	"name": "foo",
117	"size": 42
118	}
119	}
120	],
121	"url": "foo"
122	},
123	"scope": {
124	"id": 42,
125	"label": "foo",
126	"ordinal": 42,
127	"value": null
128	},
129	"title": "foo"
130	}
131	}