• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referencearticles

Update Article

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

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The article's ID.
access_levelenumOptional
Allowed values:
aliasesobjectOptional
applies_to_partsobjectOptional
artifactsobjectOptional
authored_byobjectOptional
brandstring or nullOptionalformat: "id"
The updated brand of the article.
content_blocksobjectOptional
content_formatenumOptional
Content format of the article.
Allowed values:
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
parentstring or nullOptionalformat: "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
Status of the article.
Allowed values:
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

Was this page helpful?
Previous

Get Artifact

Next
Built with
Success.

Application-defined custom fields.

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.

Bearer authentication of the form Bearer <token>, where token is your auth token.