Contents x
Adds an article to an existing category
  • 16 Mar 2023
  • 6 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Adds an article to an existing category

  • Updated on 16 Mar 2023
  • 6 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
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, categoruId, 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

Content of the article. Both markdown and HTML content are supported

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

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
Valid values[0,1,2]
Create article Request Example

Create an article with the title, categoruId, 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

Content of the article. Both markdown and HTML content are supported

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

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
Valid values[0,1,2]
Create article Request Example

Create an article with the title, categoruId, 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

Content of the article. Both markdown and HTML content are supported

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

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
Valid values[0,1,2]
Create article Request Example

Create an article with the title, categoruId, 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

Content of the article. Both markdown and HTML content are supported

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

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
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
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
object
id
string

The ID of the article

title
string

The article title

public_version
integer

The article version number(revision) that is currently published

latest_version
integer

The latest version number of this article

language_code
string
hidden
boolean

Indicates if the article is visible on the site

status
integer
Valid values[0,1,2,3,4,5]
order
integer

The position of the article inside the parent category

slug
string
content_type
integer
Valid values[0,1,2]
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

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.

{
  "data": null,
  "extension_data": null,
  "success": true,
  "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/{projectVersionId}/categories and perform the task again.

{
  "data": null,
  "extension_data": null,
  "success": true,
  "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.

{
  "data": null,
  "extension_data": null,
  "success": true,
  "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.

{
  "data": null,
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Title field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
object
id
string

The ID of the article

title
string

The article title

public_version
integer

The article version number(revision) that is currently published

latest_version
integer

The latest version number of this article

language_code
string
hidden
boolean

Indicates if the article is visible on the site

status
integer
Valid values[0,1,2,3,4,5]
order
integer

The position of the article inside the parent category

slug
string
content_type
integer
Valid values[0,1,2]
extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next