Contents x
    Publishes multiple categories
    • 29 May 2023
    • 4 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Publishes multiple categories

    • Updated on 29 May 2023
    • 4 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Post
    /v2/Categories/bulkpublish/{langCode}
    Security
    API Key
    Header parameter nameapi_token
    Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
    Path parameters
    langCode
    string Required

    Language code of the category

    Body parameters
    Published Category Request

    Category page has published successfully. the category_id, user_id, and version_number are mandatory.

    [
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
    Expand All
    Array of object
    object
    category_id
    string Required

    The ID of the category

    Min length1
    user_id
    string Required

    The ID of the team account responsible for the publish

    Min length1
    version_number
    integer Required

    Version number of the category page

    publish_message
    string

    Publish message for the category

    Published Category Request

    Category page has published successfully. the category_id, user_id, and version_number are mandatory.

    [
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
    Expand All
    Array of object
    object
    category_id
    string Required

    The ID of the category

    Min length1
    user_id
    string Required

    The ID of the team account responsible for the publish

    Min length1
    version_number
    integer Required

    Version number of the category page

    publish_message
    string

    Publish message for the category

    Published Category Request

    Category page has published successfully. the category_id, user_id, and version_number are mandatory.

    [
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
    Expand All
    Array of object
    object
    category_id
    string Required

    The ID of the category

    Min length1
    user_id
    string Required

    The ID of the team account responsible for the publish

    Min length1
    version_number
    integer Required

    Version number of the category page

    publish_message
    string

    Publish message for the category

    Published Category Request

    Category page has published successfully. the category_id, user_id, and version_number are mandatory.

    [
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
    Expand All
    Array of object
    object
    category_id
    string Required

    The ID of the category

    Min length1
    user_id
    string Required

    The ID of the team account responsible for the publish

    Min length1
    version_number
    integer Required

    Version number of the category page

    publish_message
    string

    Publish message for the category

    Responses
    200

    Success

    Successfully Published Category

    Category page

    {
  "data": [
    {
      "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
      "success": true,
      "details": "Bulk Publish Success"
    },
    {
      "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
      "success": true,
      "details": "Bulk Publish Success"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object
    object
    category_id
    string

    The ID of the category

    success
    boolean

    True - Category is published

    False - Category is not published

    details
    string

    Description of the action performed

    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

    category_id not found

    Kindly verify the category_id and perform the task again.

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

    Kindly verify the user_id and perform the task again.

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

    Kindly verify the version_number and perform the task again.

    {
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The field VersionNumber must be between 1 and 32767.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object
    object
    category_id
    string

    The ID of the category

    success
    boolean

    True - Category is published

    False - Category is not published

    details
    string

    Description of the action performed

    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