user-site

Post

/v2/Articles

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Body parameters

Create article Request Example

Create an article with the title, categoryId, projevtVersionId, and userId.

{
  "title": "New Article",
  "content": "This is my new article Content.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

title

string Required

The title of the article

Min length1

content

string | null

The content of the article, for any Editor type, use this property

category_id

string Required

The ID of the category where the article will be created

Min length1

project_version_id

string Required

The project version ID in which the article will be created

Min length1

order

integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id

string Required

The ID of the team account that will be marked as a contributor of the article

Min length1

content_type

integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]

Create article Request Example

Create an article with the title, categoryId, projevtVersionId, and userId.

{
  "title": "New Article",
  "content": "This is my new article Content.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

title

string Required

The title of the article

Min length1

content

string | null

The content of the article, for any Editor type, use this property

category_id

string Required

The ID of the category where the article will be created

Min length1

project_version_id

string Required

The project version ID in which the article will be created

Min length1

order

integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id

string Required

The ID of the team account that will be marked as a contributor of the article

Min length1

content_type

integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]

Create article Request Example

Create an article with the title, categoryId, projevtVersionId, and userId.

{
  "title": "New Article",
  "content": "This is my new article Content.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

title

string Required

The title of the article

Min length1

content

string | null

The content of the article, for any Editor type, use this property

category_id

string Required

The ID of the category where the article will be created

Min length1

project_version_id

string Required

The project version ID in which the article will be created

Min length1

order

integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id

string Required

The ID of the team account that will be marked as a contributor of the article

Min length1

content_type

integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]

Create article Request Example

Create an article with the title, categoryId, projevtVersionId, and userId.

{
  "title": "New Article",
  "content": "This is my new article Content.",
  "category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

title

string Required

The title of the article

Min length1

content

string | null

The content of the article, for any Editor type, use this property

category_id

string Required

The ID of the category where the article will be created

Min length1

project_version_id

string Required

The project version ID in which the article will be created

Min length1

order

integer (int32)

The position of the article in the category tree (By default, it will be placed at the bottom of the category)

user_id

string Required

The ID of the team account that will be marked as a contributor of the article

Min length1

content_type

integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]

Responses

200

Success

Article Created Successfully

The article has been created under the following category. you can use the article Id to view the article in the portal.

{
  "data": {
    "id": "925b69b9-f241-4d89-9e3e-208a98dfc8eb",
    "title": "Sample Article",
    "public_version": 0,
    "latest_version": 1,
    "language_code": null,
    "hidden": false,
    "status": 0,
    "order": 3,
    "slug": "sample-article",
    "content_type": null,
    "translation_option": 0,
    "is_shared_article": false
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

object (ArticleSimpleDataCustomer)

string | null

The ID of the article

title

string | null

The article title

public_version

integer (int32)

The article version number(revision) that is currently published

latest_version

integer (int32)

The latest version number of this article

language_code

string | null Deprecated

The default language code

hidden

boolean

Indicates if the article is visible on the site

status

integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]

order

integer (int32)

The position of the article inside the parent category

slug

string | null

The slug of the article

content_type

integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]

translation_option

integer (int32)

0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress

Valid values[ 0, 1, 2, 3 ]

is_shared_article

boolean

True indicates that the article is shared

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string | null

status description for customer Api response information

400

Bad Request

userId not found

Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

category_id not found

Kindly check the category_id from /v2/ProjectVersions//categories and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

project_version_id not found

Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The supplied project version id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2349 does not exist in your project.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

title not found

Kindly check the title is empty or null, and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Title field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string | null

status description for customer Api response information