Skip to content
Dixa API/
/
Update article

Update article

Request

Update a knowledge article

Security
ApiKeyAuth(Required scopes: knowledge.content:w)
Path
articleIdstring, (uuid)required
Bodyapplication/jsonrequired

The knowledge article fields to update

ownedBystring

ID of the user who owns the article

tagsobject(TagsUpdateInput)

Tags to add or remove

preReleaseboolean

Whether the article is only available in pre-release mode

PATCH
/beta/knowledge/articles/{articleId}
curl -i -X PATCH \
  'https://dev.dixa.io/beta/knowledge/articles/{articleId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ownedBy": "123e4567-e89b-12d3-a456-426614174000",
    "tags": {
      "add": [
        "tag-id-1"
      ]
    },
    "preRelease": false
  }'

Responses

The updated knowledge article

Bodyapplication/json
dataobject(Article)required

The updated article

Response
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "isDefaultLocation": true,
    "translation": { … },
    "tags": [ … ],
    "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
    "updatedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "indexedAt": "2021-12-01T12:46:36.581Z[GMT]",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "ownedBy": "123e4567-e89b-12d3-a456-426614174000",
    "indexedBy": "123e4567-e89b-12d3-a456-426614174000",
    "restrictions": { … },
    "parentCategory": "123e4567-e89b-12d3-a456-426614174000",
    "parentCollections": [ … ]
  }
}