Documentation Index

Fetch the complete documentation index at: https://apidocs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Adds multiple articles

Prev Next
Post
/v2/Articles/bulkcreate

Bulk variant of POST /v2/articles. Each entry is processed independently; if one entry fails validation, the response surfaces the per-entry error while the rest still get created. Not idempotent — retrying after a partial failure may create duplicates of the entries that originally succeeded. Filter your retry payload to only the failed entries.

Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Body parameters

A list of article creation requests. For each article, the slug property is optional — if not provided, a slug is auto-generated from the title. When provided, the slug must be unique within the workspace, otherwise an error is returned for that article.

Create Bulk Article Request Example

Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.

[
  {
    "title": "New Article 1",
    "content": "This is my first 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,
    "editor_version": null,
    "slug": null
  },
  {
    "title": "New Article 2",
    "content": "This is my second 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,
    "editor_version": null,
    "slug": null
  }
]
Array of object
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 | null

The ID of the category where the article will be created, CategoryId will be null for custom pages

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
string | null

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

Valid values[ "markdown", "wysiwyg", "block" ]
Defaultnull
editor_version
string | null

The editor to author the article in. 2 - classic editor; 3 - Editor 3.0. In projects where the Editor 3.0 flow is enabled, the article defaults to Editor 3.0 (3) when this is omitted; pass 2 for the classic editor. In projects without the V3 flow, a value of 3 is rejected.

Valid values[ "v2", "v3" ]
Defaultnull
Create Bulk Article Request Example

Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.

[
  {
    "title": "New Article 1",
    "content": "This is my first 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,
    "editor_version": null,
    "slug": null
  },
  {
    "title": "New Article 2",
    "content": "This is my second 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,
    "editor_version": null,
    "slug": null
  }
]
Array of object
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 | null

The ID of the category where the article will be created, CategoryId will be null for custom pages

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
string | null

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

Valid values[ "markdown", "wysiwyg", "block" ]
Defaultnull
editor_version
string | null

The editor to author the article in. 2 - classic editor; 3 - Editor 3.0. In projects where the Editor 3.0 flow is enabled, the article defaults to Editor 3.0 (3) when this is omitted; pass 2 for the classic editor. In projects without the V3 flow, a value of 3 is rejected.

Valid values[ "v2", "v3" ]
Defaultnull
Create Bulk Article Request Example

Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.

[
  {
    "title": "New Article 1",
    "content": "This is my first 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,
    "editor_version": null,
    "slug": null
  },
  {
    "title": "New Article 2",
    "content": "This is my second 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,
    "editor_version": null,
    "slug": null
  }
]
Array of object
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 | null

The ID of the category where the article will be created, CategoryId will be null for custom pages

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
string | null

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

Valid values[ "markdown", "wysiwyg", "block" ]
Defaultnull
editor_version
string | null

The editor to author the article in. 2 - classic editor; 3 - Editor 3.0. In projects where the Editor 3.0 flow is enabled, the article defaults to Editor 3.0 (3) when this is omitted; pass 2 for the classic editor. In projects without the V3 flow, a value of 3 is rejected.

Valid values[ "v2", "v3" ]
Defaultnull
Create Bulk Article Request Example

Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.

[
  {
    "title": "New Article 1",
    "content": "This is my first 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,
    "editor_version": null,
    "slug": null
  },
  {
    "title": "New Article 2",
    "content": "This is my second 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,
    "editor_version": null,
    "slug": null
  }
]
Array of object
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 | null

The ID of the category where the article will be created, CategoryId will be null for custom pages

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
string | null

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

Valid values[ "markdown", "wysiwyg", "block" ]
Defaultnull
editor_version
string | null

The editor to author the article in. 2 - classic editor; 3 - Editor 3.0. In projects where the Editor 3.0 flow is enabled, the article defaults to Editor 3.0 (3) when this is omitted; pass 2 for the classic editor. In projects without the V3 flow, a value of 3 is rejected.

Valid values[ "v2", "v3" ]
Defaultnull
Responses
200

Operation succeeded. Inspect the response envelope's success flag and the result/data payload.

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": [
    {
      "index": 0,
      "article_id": "d83f3388-7493-489f-ab51-249d4e6a25ce",
      "success": true,
      "details": "Successfully created article c1"
    },
    {
      "index": 0,
      "article_id": "5cabbba1-fc2a-4f82-9dee-01759509b109",
      "success": true,
      "details": "Successfully created article c2"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (BulkArticleResultCustomer) | null

Bulk article create response

object
index
integer (int32)

The zero-based position of this item in the original request array.

article_id
string | null

Article ID that has updated

success
boolean

Indicates if articles creation was successful

details
string | null

Additional information about articles creation status

extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object

One non-fatal warning attached to an otherwise-successful response.

extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

The request body or query parameters failed validation. Inspect errors[].description for the offending fields.

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": "Failed to create article c2\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
project_version_id not foundd

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": "Failed to create article c1\r\nError: The supplied workspace id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2341 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": "Failed to create article c1\r\nError: Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.",
      "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 | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object

One non-fatal warning attached to an otherwise-successful response.

extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

401

Authentication failed — the api_token header is missing, malformed, or has been revoked.

Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object

One non-fatal warning attached to an otherwise-successful response.

extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

429

Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.

Headers
Retry-After
integer
Number of seconds to wait before retrying the request.
X-RateLimit-Limit
integer
The maximum number of requests allowed in the current window.
X-RateLimit-Remaining
integer
The number of requests remaining in the current window.
X-RateLimit-Reset
integer
Unix timestamp (seconds) at which the current rate-limit window resets.
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object

One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.

extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object

One non-fatal warning attached to an otherwise-successful response.

extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object

One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.

extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.