articles

Update Article

POST
Updates an article.

Request

This endpoint expects an object.
id
stringRequired
The article's ID.
access_level
enumOptional
Allowed values: externalinternalprivatepublicrestricted
applies_to_parts
objectOptional
artifacts
objectOptional
authored_by
objectOptional
description
stringOptional
Updated description of the article object, or unchanged if not provided.
extracted_content
objectOptional
language
stringOptional
Updates the language of the article.
owned_by
objectOptional
parent
stringOptional
The updated parent directory for the article.
published_version
stringOptional
Updates the the latest published version.
reorder
objectOptional
shared_with
objectOptional
status
enumOptional
Status of the article.
Allowed values: archiveddraftpublishedreview_needed
tags
objectOptional
title
stringOptional
Updated title of the article object, or unchanged if not provided.
url
stringOptional
Updates the URL of the external article.

Response

This endpoint returns an object
article
object
POST
1curl -X POST https://api.devrev.ai/articles.update \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "id": "ARTICLE-12345"
6}'
200
Successful
1{
2  "article": {
3    "applies_to_parts": [],
4    "id": "id",
5    "created_date": "2023-01-01T12:00:00Z",
6    "description": "description",
7    "display_id": "display_id",
8    "extracted_content": [
9      {
10        "id": "id"
11      }
12    ],
13    "modified_date": "2023-01-01T12:00:00Z",
14    "num_downvotes": 1,
15    "num_upvotes": 1,
16    "parent": {
17      "id": "id",
18      "display_id": "display_id"
19    },
20    "rank": "rank",
21    "resource": {
22      "artifacts": [
23        {
24          "id": "id"
25        }
26      ],
27      "url": "url"
28    },
29    "title": "title"
30  }
31}
Built with