Update settings for the category

02 Nov 2024
9 Minutes To Read
Contributors

Print
Share
Dark mode
Light
PDF

Update settings for the category

Updated On 02 Nov 2024
9 Minutes To Read
Contributors

Print
Share
Dark mode
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Put

/v2/Categories/{categoryId}/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

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": "2024-06-13T02:30:00Z",
  "exclude_from_search": true,
  "exclude_from_ai_search": false,
  "related_articles": [],
  "content_type": 0,
  "is_acknowledgement_enabled": false
}

object

slug

string | null

The slug of the article

seo_title

string | null

The SEO title of the article

description

string | null

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

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

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

exclude_from_ai_search

boolean

true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information

related_articles

Array of string | null

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

string

content_type

integer (int32)

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

Valid values[ 0, 1, 2 ]

is_acknowledgement_enabled

boolean

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": "2024-06-13T02:30:00Z",
  "exclude_from_search": true,
  "exclude_from_ai_search": false,
  "related_articles": [],
  "content_type": 0,
  "is_acknowledgement_enabled": false
}

object

slug

string | null

The slug of the article

seo_title

string | null

The SEO title of the article

description

string | null

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

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

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

exclude_from_ai_search

boolean

true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information

related_articles

Array of string | null

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

string

content_type

integer (int32)

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

Valid values[ 0, 1, 2 ]

is_acknowledgement_enabled

boolean

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": "2024-06-13T02:30:00Z",
  "exclude_from_search": true,
  "exclude_from_ai_search": false,
  "related_articles": [],
  "content_type": 0,
  "is_acknowledgement_enabled": false
}

object

slug

string | null

The slug of the article

seo_title

string | null

The SEO title of the article

description

string | null

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

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

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

exclude_from_ai_search

boolean

true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information

related_articles

Array of string | null

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

string

content_type

integer (int32)

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

Valid values[ 0, 1, 2 ]

is_acknowledgement_enabled

boolean

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": "2024-06-13T02:30:00Z",
  "exclude_from_search": true,
  "exclude_from_ai_search": false,
  "related_articles": [],
  "content_type": 0,
  "is_acknowledgement_enabled": false
}

object

slug

string | null

The slug of the article

seo_title

string | null

The SEO title of the article

description

string | null

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

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

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

exclude_from_ai_search

boolean

true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information

related_articles

Array of string | null

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

string

content_type

integer (int32)

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

Valid values[ 0, 1, 2 ]

is_acknowledgement_enabled

boolean

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

This is to get category settings data

slug

string | null

The slug of the category

seo_title

string | null

SEO title of the category

description

string | null

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

URL of the featured image

tags

Array of string | null

List of Tags associated to the category

string

status_indicator

integer (int32)

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

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

exclude_from_ai_search

boolean

true - The AI search assistant will not fetch information from this page category; false - The AI search assistant will not exclude this page category while fetching information

related_articles

Array of object (RelatedArticleData) | null

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

object

string | null

The ID of the article

title

string | null

The title of the article

hidden

boolean

True indicates that the article is hidden

slug

string | null

The slug of the article

content_type

integer (int32)

0 - Markdown content; 1 - HTML content

Valid values[ 0, 1, 2 ]

is_acknowledgement_enabled

boolean

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

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

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

Get settings for the Category