Updates multiple articles
  • 16 Mar 2023
  • 6 Minutes to read
  • Contributors
  • Dark
    Light

Updates multiple articles

  • Dark
    Light

Put
/v2/Articles/bulkupdate
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
Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

[
  {
    "article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
    "lang_code": "en",
    "title": "Updated Title",
    "content": "updating content",
    "html_content": "

updating content

", "category_id": "68212cec-7a9b-4323-9bb8-33865444a508", "hidden": false, "version_number": 1, "translation_option": "", "source": "" } ]
Expand All
Array of object
object
article_id
string

The ID of the article

lang_code
string

Language code of the article

title
string

The title of the article

content
string

The markdown content of the article. If the editor type is Markdown, use this property

html_content
string

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

[
  {
    "article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
    "lang_code": "en",
    "title": "Updated Title",
    "content": "updating content",
    "html_content": "

updating content

", "category_id": "68212cec-7a9b-4323-9bb8-33865444a508", "hidden": false, "version_number": 1, "translation_option": "", "source": "" } ]
Expand All
Array of object
object
article_id
string

The ID of the article

lang_code
string

Language code of the article

title
string

The title of the article

content
string

The markdown content of the article. If the editor type is Markdown, use this property

html_content
string

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

[
  {
    "article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
    "lang_code": "en",
    "title": "Updated Title",
    "content": "updating content",
    "html_content": "

updating content

", "category_id": "68212cec-7a9b-4323-9bb8-33865444a508", "hidden": false, "version_number": 1, "translation_option": "", "source": "" } ]
Expand All
Array of object
object
article_id
string

The ID of the article

lang_code
string

Language code of the article

title
string

The title of the article

content
string

The markdown content of the article. If the editor type is Markdown, use this property

html_content
string

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

[
  {
    "article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
    "lang_code": "en",
    "title": "Updated Title",
    "content": "updating content",
    "html_content": "

updating content

", "category_id": "68212cec-7a9b-4323-9bb8-33865444a508", "hidden": false, "version_number": 1, "translation_option": "", "source": "" } ]
Expand All
Array of object
object
article_id
string

The ID of the article

lang_code
string

Language code of the article

title
string

The title of the article

content
string

The markdown content of the article. If the editor type is Markdown, use this property

html_content
string

The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property

category_id
string

The ID of the category. If the article has to be moved to another category, enter the desired category ID

hidden
boolean

Visibility status of the article. true - Article will be hidden; false - Article will be shown

version_number
integer

The version number of the article to be updated. The latest version is updated by default.

translation_option
string

Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated

source
string

Free text used for future reference

Responses
200

Success

Success response for bulk article update.

This is an response that indicate the bulk articles has updated successfully.

{
  "data": [
    {
      "article_id": "0e9a3cf2-b5ce-46d4-a637-604cb8407b93",
      "success": true,
      "details": "Successfully updated article with an id 0e9a3cf2-b5ce-46d4-a637-604cb8407b93"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object

Bulk updated article data

object
article_id
string

Article Id that has updated

success
boolean

Indicates if articles creation was successful

details
string

Additional information about articles creation status

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

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "A non-empty request body is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object

Bulk updated article data

object
article_id
string

Article Id that has updated

success
boolean

Indicates if articles creation was successful

details
string

Additional information about articles creation status

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?