invantive documentation
Invantive Support ForumsLog In / Sign Up

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_id 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_banner varchar2 itgen_crp_appearance_banner filters on the platform, writable, appearance.banner Banner image URL (if any).
appearance_logos_footer varchar2 itgen_crp_appearance_logos_footer filters on the platform, writable, appearance.logos.footer Footer logo URL (if any).
appearance_logos_header varchar2 itgen_crp_appearance_logos_header filters on the platform, writable, appearance.logos.header Header logo URL (if any).
behavior_ask_feedback char itgen_crp_behavior_ask_feedback filters on the platform, writable, behavior.ask_feedback Whether to ask for user feedback at the end of an article or not.
behavior_forbid_indexing char itgen_crp_behavior_forbid_indexing filters on the platform, writable, behavior.forbid_indexing Whether to forbid search engine indexing of all helpdesk pages or not.
behavior_frequently_read char itgen_crp_behavior_frequently_read filters on the platform, writable, behavior.frequently_read Whether to show frequently read articles on the home page or not.
behavior_locale_picker char itgen_crp_behavior_locale_picker filters on the platform, writable, behavior.locale_picker Whether to show a locale picker in the header or not.
behavior_refer_link char itgen_crp_behavior_refer_link filters on the platform, writable, behavior.refer_link Whether to show a link to Crisp in the footer or not.
behavior_show_category_images char itgen_crp_behavior_show_category_images filters on the platform, writable, behavior.show_category_images Whether to show category images on the home page or not.
behavior_show_chatbox char itgen_crp_behavior_show_chatbox filters on the platform, writable, behavior.show_chatbox Whether to show the chatbox on the helpdesk or not.
behavior_status_health_dead char itgen_crp_behavior_status_health_dead filters on the platform, writable, behavior.status_health_dead Whether to show a status banner when the status page reports as dead.
include_html varchar2 itgen_crp_include_html filters on the platform, writable, include.html 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: