invantive documentation
Invantive Support ForumsLog In / Sign Up

HelpdeskArticlesByWebsiteIdAndLocale: Crisp Helpdesk Articles

read only REST

  • Catalog: Crisp
  • Schema: Crisp
  • Primary Keys: article_id
  • Label: Helpdesk Articles

Can only retrieve data.

Summary

Articles of the helpdesk of a website in one locale, without their text.

API Source

  • Endpoint: /website/{website_id}/helpdesk/locale/{locale}/articles/{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 HelpdeskArticlesByWebsiteIdAndLocale 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
article_id varchar2 itgen_crp_article_id filters on the platform, writable Article identifier.
category_color varchar2 itgen_crp_category_color filters on the platform, writable, category.color Colour of the category as a hexadecimal colour code (if any).
category_id varchar2 itgen_crp_category_id filters on the platform, writable, category.category_id Identifier of the category of the article (if any).
category_name varchar2 itgen_crp_category_name filters on the platform, writable, category.name Name of the category of the article (if any).
created_at datetime itgen_crp_created_at filters on the platform, writable Article creation timestamp.
featured char itgen_crp_featured filters on the platform, writable Whether the article is featured or not.
order int32 itgen_crp_order filters on the platform, writable Article ordering weight.
published_at datetime itgen_crp_published_at filters on the platform, writable Article publication timestamp.
section_id varchar2 itgen_crp_section_id filters on the platform, writable, category.section.section_id Identifier of the section within the category (if any).
section_name varchar2 itgen_crp_section_name filters on the platform, writable, category.section.name Name of the section within the category (if any).
status varchar2 itgen_crp_status filters on the platform, writable Status of the article; one of published and draft.
title varchar2 itgen_crp_title filters on the platform, writable Title of the article.
updated_at datetime itgen_crp_updated_at filters on the platform, writable Article update timestamp.
url varchar2 itgen_crp_url filters on the platform, writable Public URL of the article when published.
visibility varchar2 itgen_crp_visibility filters on the platform, writable Visibility of the article when published; one of visible and hidden.
visits int64 itgen_crp_visits filters on the platform, writable Number of times the article has been visited.

Release Notes

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