Skip to content
Dixa API/
/
Create article

Create article

Request

Create a knowledge article

Security
ApiKeyAuth(Required scopes: knowledge.content:w)
Bodyapplication/jsonrequired

The knowledge article to create

translationsArray of objects(TranslationInput)

Initial translations for the article

parentIdstring

ID of the parent category

tagsArray of strings

List of tag IDs to assign to the article

preReleaseboolean

Whether the article is only available in pre-release mode

POST
/v1/knowledge/articles
curl -i -X POST \
  https://dev.dixa.io/v1/knowledge/articles \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "translations": [
      {
        "languageId": "en",
        "title": "My Article",
        "content": "<p>Content</p>"
      }
    ],
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"
    ],
    "preRelease": false
  }'

Responses

The created knowledge article

Bodyapplication/json
dataobject(Article)required

The created 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": [ … ]
  }
}