Skip to content
Dixa API/
/
Publish translation

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

Create article

Request

Create a knowledge article

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

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/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
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": [ … ]
  }
}

Publish translation

Request

Publish a specific translation for search

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

Responses

Response
No content

Unpublish translation

Request

Mark a specific translation as unpublished

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

Responses

Response
No content

Organization

Operations