HelpdeskSettingsByWebsiteId: Crisp Helpdesk Settings
read only REST
- Catalog:
Crisp - Schema:
Crisp - Label: Helpdesk Settings
Can only retrieve data.
Summary
Settings of the helpdesk of a website.
API Source
- Endpoint:
/website/{website_id}/helpdesk/settings
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
website_ |
varchar2 |
The website identifier. Defaults to the website ID of the connection when left out. |
Table Columns
The columns of the table HelpdeskSettingsByWebsiteId 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 |
|---|---|---|---|---|---|
appearance_ |
varchar2 |
itgen_crp_appearance_banner | filters on the platform, writable, appearance. |
Banner image URL (if any). | |
appearance_ |
varchar2 |
itgen_crp_appearance_logos_footer | filters on the platform, writable, appearance. |
Footer logo URL (if any). | |
appearance_ |
varchar2 |
itgen_crp_appearance_logos_header | filters on the platform, writable, appearance. |
Header logo URL (if any). | |
behavior_ |
char |
itgen_crp_behavior_ask_feedback | filters on the platform, writable, behavior. |
Whether to ask for user feedback at the end of an article or not. | |
behavior_ |
char |
itgen_crp_behavior_forbid_indexing | filters on the platform, writable, behavior. |
Whether to forbid search engine indexing of all helpdesk pages or not. | |
behavior_ |
char |
itgen_crp_behavior_frequently_read | filters on the platform, writable, behavior. |
Whether to show frequently read articles on the home page or not. | |
behavior_ |
char |
itgen_crp_behavior_locale_picker | filters on the platform, writable, behavior. |
Whether to show a locale picker in the header or not. | |
behavior_ |
char |
itgen_crp_behavior_refer_link | filters on the platform, writable, behavior. |
Whether to show a link to Crisp in the footer or not. | |
behavior_ |
char |
itgen_crp_behavior_show_category_images | filters on the platform, writable, behavior. |
Whether to show category images on the home page or not. | |
behavior_ |
char |
itgen_crp_behavior_show_chatbox | filters on the platform, writable, behavior. |
Whether to show the chatbox on the helpdesk or not. | |
behavior_ |
char |
itgen_crp_behavior_status_health_dead | filters on the platform, writable, behavior. |
Whether to show a status banner when the status page reports as dead. | |
include_ |
varchar2 |
itgen_crp_include_html | filters on the platform, writable, include. |
Raw HTML include (if any). | |
name |
varchar2 |
itgen_crp_name | filters on the platform, writable | Name of the helpdesk. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: