Skip to content
Dixa API/
/
Get article translations

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Update article

Request

Update a knowledge article

Security
ApiKeyAuth
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

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/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
data.​idstringrequired
data.​isDefaultLocationboolean
data.​translationobject(Translation)
data.​tagsArray of strings
data.​createdAtstring(date-time)required
data.​updatedAtstring(date-time)required
data.​indexedAtstring(date-time)
data.​createdBystring
data.​updatedBystring
data.​ownedBystring
data.​indexedBystring
data.​restrictionsobject(Restrictions)required
data.​restrictions.​isRestrictedbooleanrequired
data.​restrictions.​inheritedRestrictionsArray of objects(InheritedRestriction)
data.​parentCategorystring
data.​parentCollectionsArray of strings
Response
application/json
{
  "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": [ … ]
  }
}

Get article translations

Request

Get a knowledge article translations

Security
ApiKeyAuth
Path
articleIdstring(uuid)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/articles/{articleId}/translations' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The article translations

Bodyapplication/json
dataobject(ArticleTranslations)required
data.​translationsobject(TranslationList)required
data.​translations.​draftArray of objects(ArticleTranslation)
data.​translations.​publishedArray of objects(ArticleTranslation)
Response
application/json
{
  "data": {
    "translations": { … }
  }
}

Update article translations

Request

Update translations for a knowledge article. Supports partial success.

Security
ApiKeyAuth
Path
articleIdstring(uuid)required
Bodyapplication/jsonrequired

The translations to update for the article

translationsArray of objects(TranslationInput)

List of translations to create or update

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/knowledge/articles/{articleId}/translations' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "translations": [
      {
        "languageId": "en",
        "title": "My Article",
        "content": "<p>Hello world</p>"
      }
    ]
  }'

Responses

The updated translations, with partial errors if any

Bodyapplication/json
dataArray of objects(ArticleTranslation)

Successfully upserted translations

partialErrorsArray of objects(TranslationError)

Errors for translations that failed

Response
application/json
{
  "data": [
    { … }
  ]
}

Organization

Operations