Update KView

KViews control how records look to agents. Each KView belongs to one resource (customer, company, conversation, or a custom object type written as kobject.<klass>) and renders in one context. Admins build them in Kustomer's KView editor, and apps install them from the kviews section of an app definition. Through this API you can read, edit, enable or disable, and reorder existing KViews; creating them happens in the editor or through an app.

Contexts

meta.displayName is the card's title and meta.icon its header icon. enabled turns a KView on or off without deleting it.

Code and visual KViews

A KView is stored in one of two forms. When advanced is true, template holds JSX source that Kustomer evaluates in the browser, with access to the record, lodash, Moment.js and Kustomer's UI components; the KViews guide describes what's in scope. Otherwise the view was built in the visual editor and is stored as layout, a tree of row, column and component nodes, plus components, which maps each component ID to its componentType and componentAttributes. Editing template through the API is straightforward; leave layout and components to the editor.

Order and app-installed views

When several KViews share a resource and context, such as many cards on conversations, they appear in the order set by PUT /v1/kviews/{resource}/{context}/order. Send kviews as the full list of KView IDs in the order you want, up to 200. GET /v1/kviews/{resource} with a context returns views in that order. KViews installed by an app are hidden while the app is disabled, and the appDisabled filter lets you include or exclude them.

Which endpoint to use

Reading KViews works with agent or admin read roles; editing and reordering need a KView write role. A change applies to every agent as soon as it's saved, so try template edits in a sandbox org first and keep a copy of the previous template before you overwrite it. For KViews that belong to an app, change the app definition instead: an upgrade to a version where the KView changed updates it from the definition.