Update settings for the category

25 Nov 2023
8 Minutes to read
Contributors

Print
Share
Dark
Light

Update settings for the category

Updated on 25 Nov 2023
8 Minutes to read
Contributors

Print
Share
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

Put

/v2/Categories/{categoryId}/{langCode}/settings

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

categoryId

stringRequired

The ID of the category

langCode

stringRequired

Language code of the category

Default"en"

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.

{
  "slug": "updatedslug",
  "seo_title": "updatedSeoTitle",
  "description": "This is the description in updating category settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 1,
  "status_indicator_expiry_date": "2023-11-25T10:59:35.0754268Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}

object

slug

string

The slug of the article

seo_title

string

The SEO title of the article

description

string

The SEO description of the article

allow_comments

boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents

boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags

Array of string

Custom article tags

string

status_indicator

integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time)

The date-time when the public article status is removed

exclude_from_search

boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles

Array of string

The list of related article IDs to show in the knowledge base

string

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]

Non-Empty body is required.

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

{
  "slug": "updatedslug",
  "seo_title": "updatedSeoTitle",
  "description": "This is the description in updating category settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 1,
  "status_indicator_expiry_date": "2023-11-25T10:59:35.0754268Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}

object

slug

string

The slug of the article

seo_title

string

The SEO title of the article

description

string

The SEO description of the article

allow_comments

boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents

boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags

Array of string

Custom article tags

string

status_indicator

integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time)

The date-time when the public article status is removed

exclude_from_search

boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles

Array of string

The list of related article IDs to show in the knowledge base

string

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]

Non-Empty body is required.

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

{
  "slug": "updatedslug",
  "seo_title": "updatedSeoTitle",
  "description": "This is the description in updating category settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 1,
  "status_indicator_expiry_date": "2023-11-25T10:59:35.0754268Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}

object

slug

string

The slug of the article

seo_title

string

The SEO title of the article

description

string

The SEO description of the article

allow_comments

boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents

boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags

Array of string

Custom article tags

string

status_indicator

integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time)

The date-time when the public article status is removed

exclude_from_search

boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles

Array of string

The list of related article IDs to show in the knowledge base

string

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]

Non-Empty body is required.

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

{
  "slug": "updatedslug",
  "seo_title": "updatedSeoTitle",
  "description": "This is the description in updating category settings.",
  "allow_comments": true,
  "show_table_of_contents": true,
  "tags": [],
  "status_indicator": 1,
  "status_indicator_expiry_date": "2023-11-25T10:59:35.0754268Z",
  "exclude_from_search": true,
  "related_articles": [],
  "content_type": 0
}

object

slug

string

The slug of the article

seo_title

string

The SEO title of the article

description

string

The SEO description of the article

allow_comments

boolean

Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled

show_table_of_contents

boolean

Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled

tags

Array of string

Custom article tags

string

status_indicator

integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time)

The date-time when the public article status is removed

exclude_from_search

boolean

true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base

related_articles

Array of string

The list of related article IDs to show in the knowledge base

string

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]

Responses

200

Success

Successfully updated the setings.

This response indicate a category settings has been successfully updated.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

object (CategorySettingsCustomer)

slug

string

The slug of the category

seo_title

string

SEO title of the category

description

string

SEO description of the category

allow_comments

boolean

Allow comments for category

show_table_of_contents

boolean

True - Table of Contents will be enabled False - Table of Contents will be disabled

featured_image_url

string

URL of the featured image

tags

Array of string

List of Tags associated to the category

string

status_indicator

integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time)

The number of days after which the article status will be removed

exclude_from_search

boolean

true - The caetgory will not appear in search results in the knowledge base false - The category will appear in search results in the knowledge base

related_articles

Array of object (RelatedArticleData)

The list of related article IDs to show in the knowledge base

object

string

The ID of the article

title

string

The title of the article

hidden

boolean

True indicates that the article is hidden

slug

string

The slug of the article

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

stack_trace

string

Stack trace for error response message

description

string

Description for error cause

error_code

string

Error code for Api response

custom_data

object

warnings

Array of object (BaseWarning)

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

400

Bad Request

Category Not Found.

Kindly verifty the category Id or the langCode, and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": ".Category not found",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

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

data

object (CategorySettingsCustomer)

slug

string

The slug of the category

seo_title

string

SEO title of the category

description

string

SEO description of the category

allow_comments

boolean

Allow comments for category

show_table_of_contents

boolean

True - Table of Contents will be enabled False - Table of Contents will be disabled

featured_image_url

string

URL of the featured image

tags

Array of string

List of Tags associated to the category

string

status_indicator

integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]

status_indicator_expiry_date

string (date-time)

The number of days after which the article status will be removed

exclude_from_search

boolean

true - The caetgory will not appear in search results in the knowledge base false - The category will appear in search results in the knowledge base

related_articles

Array of object (RelatedArticleData)

The list of related article IDs to show in the knowledge base

object

string

The ID of the article

title

string

The title of the article

hidden

boolean

True indicates that the article is hidden

slug

string

The slug of the article

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[ 0, 1, 2 ]

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

stack_trace

string

Stack trace for error response message

description

string

Description for error cause

error_code

string

Error code for Api response

custom_data

object

warnings

Array of object (BaseWarning)

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

Was this article helpful?

What's Next

Update multiple page categories