invantive documentation
Invantive Support ForumsLog In / Sign Up

HelpdeskCategoriesByWebsiteIdAndLocale: Crisp Helpdesk Categories

read only REST

  • Catalog: Crisp
  • Schema: Crisp
  • Primary Keys: category_id
  • Label: Helpdesk Categories

Can only retrieve data.

Summary

Categories of the helpdesk of a website in one locale.

API Source

  • Endpoint: /website/{website_id}/helpdesk/locale/{locale}/categories/{page_number}

Parameters

Name Data Type Required Default Documentation
locale varchar2 The locale code of the helpdesk (ISO 639-1).
website_id varchar2 The website identifier. Defaults to the website ID of the connection when left out.

Table Columns

The columns of the table HelpdeskCategoriesByWebsiteIdAndLocale are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
articles int64 itgen_crp_articles filters on the platform, writable Number of articles in the category.
category_id varchar2 itgen_crp_category_id filters on the platform, writable Category identifier.
color varchar2 itgen_crp_color filters on the platform, writable Colour of the category as a hexadecimal colour code (if any).
created_at datetime itgen_crp_created_at filters on the platform, writable Category creation timestamp.
description varchar2 itgen_crp_description filters on the platform, writable Description of the category (if any).
image varchar2 itgen_crp_image filters on the platform, writable Image URL of the category (if any).
name varchar2 itgen_crp_name filters on the platform, writable Name of the category.
order int32 itgen_crp_order filters on the platform, writable Category ordering weight.
sections int64 itgen_crp_sections filters on the platform, writable Number of sections in the category.
updated_at datetime itgen_crp_updated_at filters on the platform, writable Category update timestamp.
url varchar2 itgen_crp_url filters on the platform, writable Public URL of the category.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: