Login
    Contents x
    Updates multiple articles
    • 02 Nov 2024
    • 7 Minutes To Read
    • Contributors
    • Print
    • Dark mode
      Light
    • PDF
    Contents

    Updates multiple articles

    • Updated On 02 Nov 2024
    • 7 Minutes To Read
    • Contributors
    • Print
    • Dark mode
      Light
    • PDF
    Article summary

    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": "",
    "order": 0
  }
]
    Array of object
    object
    article_id
    string | null

    The ID of the article

    lang_code
    string | null

    Language code of the article

    title
    string | null

    The title of the article

    content
    string | null

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

    html_content
    string | null Deprecated

    The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

    category_id
    string | null

    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 (int32) | null

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

    translation_option
    string | null

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

    source
    string | null

    Free text used for future reference

    order
    integer (int32)

    To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

    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": "",
    "order": 0
  }
]
    Array of object
    object
    article_id
    string | null

    The ID of the article

    lang_code
    string | null

    Language code of the article

    title
    string | null

    The title of the article

    content
    string | null

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

    html_content
    string | null Deprecated

    The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

    category_id
    string | null

    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 (int32) | null

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

    translation_option
    string | null

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

    source
    string | null

    Free text used for future reference

    order
    integer (int32)

    To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

    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": "",
    "order": 0
  }
]
    Array of object
    object
    article_id
    string | null

    The ID of the article

    lang_code
    string | null

    Language code of the article

    title
    string | null

    The title of the article

    content
    string | null

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

    html_content
    string | null Deprecated

    The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

    category_id
    string | null

    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 (int32) | null

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

    translation_option
    string | null

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

    source
    string | null

    Free text used for future reference

    order
    integer (int32)

    To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

    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": "",
    "order": 0
  }
]
    Array of object
    object
    article_id
    string | null

    The ID of the article

    lang_code
    string | null

    Language code of the article

    title
    string | null

    The title of the article

    content
    string | null

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

    html_content
    string | null Deprecated

    The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)

    category_id
    string | null

    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 (int32) | null

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

    translation_option
    string | null

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

    source
    string | null

    Free text used for future reference

    order
    integer (int32)

    To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).

    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 (BulkArticleResultCustomer) | null

    Bulk updated article data

    object
    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

    Extention data for customer API response

    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError) | null

    Errors in the customer API response

    object
    extension_data
    object | null

    Thids is the Extention data object

    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
    property*
    warnings
    Array of object (BaseWarning) | null

    Warnings in the customer API response

    object
    extension_data
    object | null

    Extention Data for customer Api warning

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

    Extention data for customer Api response information

    description
    string | null

    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.

    {
  "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
    extension_data
    object | null

    Extention data for customer API response

    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError) | null

    Errors in the customer API response

    object
    extension_data
    object | null

    Thids is the Extention data object

    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
    property*
    warnings
    Array of object (BaseWarning) | null

    Warnings in the customer API response

    object
    extension_data
    object | null

    Extention Data for customer Api warning

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

    Extention data for customer Api response information

    description
    string | null

    status description for customer Api response information

    Was this article helpful?
    What's Next
    Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
    Products
    Company
    Top Features
    Solutions
    Existing Users
    Connect With Us
    Sales and Support
    Copyright © Abc Inc. All Rights Reserved
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout