Zoho: Kiosks states schemas (part 1)
68 Zoho schemas with complete fields and constraints.
← Kiosks states operations · All schemas
Create a kiosk state — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body for creating a kiosk state. The states array contains exactly one state object, and the type field determines which details schema applies. Additional keys: not allowed |
states | array | Required within parent | Represents the array containing exactly one state object to create. Maximum items: 1 |
states[] | Model | Each item | Expand Create a kiosk state — request body — body states item |
Referenced models: Create a kiosk state — request body — body states item
Create a kiosk state — request body — body states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the kiosk state creation payload. The type field determines whether the state is a screen, decision, action, or get_records state, and the corresponding structure of the details object. Additional keys: not allowed |
details | JSON | Required within parent | Represents the state-specific configuration object. The structure varies by the state type: screen uses ScreenCreateDetails, decision uses DecisionCreateDetails, action uses ActionCreateDetails, and get_records uses GetRecordCreateDetails. |
details (anyOf 1) | Model | Alternative | Expand Create a kiosk state — request body — body states item details screen details |
details (anyOf 2) | Model | Alternative | Expand Kiosk State — request body — body states item details path details |
details (anyOf 3) | Model | Alternative | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks |
details (anyOf 4) | Model | Alternative | Expand Create a kiosk state — request body — body states item details get record |
from_transition | Model | Required within parent | Expand Create a kiosk state — request body — body states item from transition |
name | string | Required within parent | Specify the unique display name of the state. The maximum length is 50 characters, and it must match the regex pattern [0-9a-zA-Z_\-\.\|\$\?\,\'\/\!\P{InBasicLatin}\s]+. Maximum length: 250 |
type | string | Required within parent | Represents the type of the kiosk state. Determines the structure of the details configuration object. Possible values: screen - A visual screen state with form elements. decision - A conditional branching state. action - A CRM operation state. get_records - A record retrieval state. One of: screen, decision, action, get_records |
$ (allOf 1) | JSON | All variants apply | Represents the from_transition property that identifies the transition edge activating the new kiosk state. |
$ (allOf 2) | JSON | All variants apply | Represents the name property that defines the display name of the new kiosk state. |
$ (allOf 3) | JSON | All variants apply | Represents the type discriminator property that specifies the state type. |
$ (allOf 4) | JSON | All variants apply | Represents the details property containing the state-specific configuration object. |
Referenced models: Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks, Kiosk State — request body — body states item details path details, Create a kiosk state — request body — body states item from transition, Create a kiosk state — request body — body states item details get record, Create a kiosk state — request body — body states item details screen details
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for a kiosk action state. The structure is composed using allOf to include one or more optional action-type properties depending on the configured action. Additional keys: not allowed |
add_meeting | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting Configuration for the add_meeting action. Referenced from AutomationNonAssociateActions.json. |
add_tags | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags Configuration for the add_tags action. Referenced from AutomationNonAssociateActions.json. |
api_name | string or null | Optional | Represents the merge field expression used to dynamically resolve the owner for the assign_owner action when the user is not provided directly. Three formats are supported: (1) Record field — `${!<kiosk_group_api_name>.<resource_api_name>.<field_api_name>}`, where the resource is `CurrentRecord` or a GetRecord API name. (2) CRM module field — `${!<module_api_name>.<field_api_name>}`, for example, `${!users.email}`. (3) Kiosk screen field — `${!<kiosk_group_api_name>.<screen_field_api_name>}`. Maximum length: 200 |
assign_owner | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner Configuration for the assign_owner action. Referenced from AutomationNonAssociateActions.json. |
convert | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert Configuration for the convert action. Referenced from AutomationNonAssociateActions.json. |
create_record | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record Configuration for the create_record action. Referenced from AutomationNonAssociateActions.json. |
criteria | Model | Optional | Expand Related Records — request body — query filters Criteria for ownership assignment comparison. Referenced from Criterion.json. |
email_notifications | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks email notifications Associates an action that triggers an email notification for records fetched via get record or current record. |
execute_for_record | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks execute for record For associate actions and few non associate actions, the action should be performed on a specific record in the CRM system. For example, if the user is creating the field update action to modify a company name, he must provide which record's company name should be changed. So, he should provide either a get record reference or a current record reference in "execute_for_record" key. ID and name of the resource will be enough. However, for actions which are unrelated for a specific record, this key can be ignored. |
field_updates | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks field updates Associates an action that updates a field's value in a record fetched via get record or current record. |
functions | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks functions Associates an action that triggers a function for records fetched via get record or current record. |
get_record | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks get record This is the JSON which contains the association details of the get_record component for a get_records state. |
note | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note Configuration used to create a note associated with a CRM record. For example, a specific Lead detail view page can have a note by running this particular action. |
open_link | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open link Open link is an action used to open a specific link which is configured during state creation when triggered. This json will consist of the link and encoding details. |
open_record | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open record It is an action to open a particular record fetched from the CRM modules. The user will configure either a get record or a current record with this action. The fetched record is opened automatically when the action is executed. |
quick_create_record | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record It is an action used to quickly configure a create record action with minimal field input. However, there will be a pop up during the execution of the action where the user must provide the values for the fields configured. Then, the record will be created. |
remove_tags | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags Configuration for the remove_tags action. Referenced from AutomationNonAssociateActions.json. |
schedule_call | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call Configuration for the schedule_call action. Referenced from AutomationNonAssociateActions.json. |
tasks | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks tasks Associates an action that triggers a task for records fetched via get record or current record. |
type | string or null | Optional | Indicates the action type for the kiosk action state. The specified type determines which action configuration object must be present in the details object. One of: field_updates, assign_owner, add_tags, create_record, note, remove_tags, email_notifications, tasks, webhooks, functions, add_meeting, schedule_call, convert, open_record, open_link, quick_create_record Maximum length: 50 |
webhooks | Model | Optional | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks webhooks Associates an action that triggers a webhook for records fetched via get record or current record. |
$ (allOf 1) | JSON | All variants apply | Represents the optional execute_for_record property, which identifies the CRM record or get_record component on which the action is performed. |
$ (allOf 2) | JSON | All variants apply | Represents the optional note property for the add note action. |
$ (allOf 3) | JSON | All variants apply | Represents the optional functions property for the function action. |
$ (allOf 4) | JSON | All variants apply | Represents the optional open_record property for the open record action. |
$ (allOf 5) | JSON | All variants apply | Represents the optional get_record property for associating a get_record component with the action. |
$ (allOf 6) | JSON | All variants apply | Represents the optional criteria property containing the filter conditions used to evaluate ownership assignment. |
$ (allOf 7) | JSON | All variants apply | Represents the optional open_link property for the open link action. |
$ (allOf 8) | JSON | All variants apply | Represents the optional convert property for the convert action. |
$ (allOf 9) | JSON | All variants apply | Represents the type discriminator property that specifies the action type. |
$ (allOf 10) | JSON | All variants apply | Represents the optional create_record property for the create record action. |
$ (allOf 11) | JSON | All variants apply | Represents the optional assign_owner property for the assign owner action, including the criteria or merge field used to resolve the owner. |
$ (allOf 12) | JSON | All variants apply | Represents the optional remove_tags property for the remove tags action. |
$ (allOf 13) | JSON | All variants apply | Represents the optional add_meeting property for the add meeting action. |
$ (allOf 14) | JSON | All variants apply | Represents the optional webhooks property for the webhook action. |
$ (allOf 15) | JSON | All variants apply | Represents the optional api_name property containing the merge field expression used to resolve the owner dynamically for the assign_owner action. |
$ (allOf 16) | JSON | All variants apply | Represents the optional email_notifications property for the email notification action. |
$ (allOf 17) | JSON | All variants apply | Represents the optional field_updates property for the field update action. |
$ (allOf 18) | JSON | All variants apply | Represents the optional quick_create_record property for the quick create record action. |
$ (allOf 19) | JSON | All variants apply | Represents the optional tasks property for the tasks action. |
$ (allOf 20) | JSON | All variants apply | Represents the optional schedule_call property for the schedule call action. |
$ (allOf 21) | JSON | All variants apply | Represents the optional add_tags property for the add tags action. |
$ (allOf 22) | JSON | All variants apply | Represents the optional sequential_action_details property for configuring whether the action runs sequentially and handles failure paths. |
Referenced models: Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks email notifications, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks execute for record, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks field updates, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks functions, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks get record, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open link, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open record, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks tasks, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks webhooks, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call, Related Records — request body — query filters, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks email notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action configuration for triggering an email notification for records fetched via get record or current record. Additional keys: not allowed |
id | string | Required within parent | Represents the record ID of the email notification action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Maximum length: 20 |
name | string or null | Optional | Represents the name of the email notification action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Maximum length: 250 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks execute for record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the resource reference used to identify the CRM record on which an action is performed. The resource can be either a get_record component or a current_record reference. Additional keys: not allowed |
id | string | Required within parent | Represents the ID of the resource used for the action. This ID identifies the specific get_record or current_record component to be retrieved when performing the action. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the resource used for the action. Maximum length: 50 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks field updates
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the field update action configuration for a kiosk action state. Contains the identifier and name of the pre-created field update workflow action to be associated. Additional keys: not allowed |
id | string | Required within parent | Represents the record ID of the field update action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Maximum length: 20 |
name | string or null | Optional | Represents the name of the field update action associated with the kiosk action state. Maximum length: 50 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks functions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action configuration for triggering a function for records fetched via get record or current record. Additional keys: not allowed |
id | string | Required within parent | Represents the record ID of the function action pre-created in Zoho CRM workflow and associated with the kiosk action state. Format: int64 |
name | string or null | Optional | Represents the name of the function action pre-created in Zoho CRM workflow and associated with the kiosk action state. Maximum length: 50 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the association details for linking an existing get_record component to a new kiosk state. Additional keys: not allowed |
id | string | Required within parent | Represents the ID of the get_record component associated with this kiosk state. Maximum length: 18 |
name | string | Required within parent | Represents the name of the get_record component associated with this kiosk state. Maximum length: 50 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the note configuration for the add note action. Defines the module, content, title, and optional attachments of the note to be created. Additional keys: not allowed |
attachments | array or null | Optional | Represents the list of attachments for the note created by the add note action. Each object contains a merge field reference to a File Upload field. Maximum items: 1 |
attachments[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note attachments item |
content | string | Required within parent | Represents the content of the note displayed on the record detail view. Maximum length: 5000 |
module | Model | Required within parent | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module Specifies the CRM module to which the note will be associated. For example, Leads module can have a note associated with it. (Required) |
title | string or null | Optional | Represents the title of the note associated with the CRM record. Maximum length: 50 |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note attachments item, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the CRM module reference for the tags action. Identifies the module in which tags are added or removed. Additional keys: not allowed |
api_name | string or null | Optional | Represents the unique API name of the CRM module for which tags are configured. Maximum length: 50 |
id | string | Required within parent | Represents the unique ID of the CRM module for which tags are configured. Maximum length: 19 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the open link action configuration, including the URL to open and the character encoding used when the action is triggered. Additional keys: not allowed |
encode | string | Required within parent | Represents the character encoding used when opening the URL, for example, UTF-8. Possible values: UTF-8 - Unicode Transformation Format with 8-bit encoding. UTF-16 - Unicode Transformation Format with 16-bit encoding. ISO-8859-1 - Latin-1 character encoding. ISO-8859-9 - Turkish character encoding. GB2312 - Simplified Chinese character encoding. Big5 - Traditional Chinese character encoding. Shift_JIS - Japanese character encoding. One of: UTF-8, UTF-16, ISO-8859-1, ISO-8859-9, GB2312, Big5, Shift_JIS Maximum length: 50 |
link | string | Required within parent | Represents the URL to be opened when the action is executed. The value must be a valid URL. Maximum length: 1000 |
name | string | Required within parent | Represents the display name of the open link action state. Maximum length: 250 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the open record action configuration. Identifies the record to be opened automatically when the action is triggered, using either a get_record or current_record reference. Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the open record action. Maximum length: 19 |
name | string | Required within parent | Represents the display name of the open record action state. Maximum length: 250 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record
Referenced models: Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record layout, Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module, Create an Automation Task — request body — body tasks item field mappings item
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the layout configuration for the meeting event being created in the kiosk action. Additional keys: not allowed |
id | string | Required within parent | Represents the layout ID for the meeting event being created. Maximum length: 19 |
name | string or null | Optional | Represents the API name of the layout for the meeting event being created. Maximum length: 50 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks tasks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Action configuration for triggering a task for records fetched via get record or current record. Additional keys: not allowed |
id | string | Required within parent | Represents the record ID of the task action pre-created in Zoho CRM Workflow and associated with the kiosk state. Each task action can be associated with only one kiosk state. Maximum length: 255 |
name | string or null | Optional | Represents the name of the task action pre-created in Zoho CRM Workflow and associated with the kiosk state. Maximum length: 250 |
Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks webhooks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the webhook action configuration for a kiosk action state. Contains the identifier and name of the pre-created webhook workflow action to be associated. Additional keys: not allowed |
id | string | Required within parent | Represents the record ID of the webhook action pre-created in Zoho CRM and associated with the kiosk action state. Format: int64 Maximum length: 20 |
name | string or null | Optional | Represents the name of the webhook action pre-created in Zoho CRM and associated with the kiosk action state. Maximum length: 9 |
Create a kiosk state — request body — body states item details get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for a kiosk get_records state. Contains the reference to the get_record component that defines which records to retrieve. Additional keys: not allowed |
get_record | object | Required within parent | Contains the reference information for the records to be retrieved. Refer to the [Kiosk Get Records API](kiosks_get_records.yaml#$.paths./settings/kiosks/{kioskId}/get_records.get)for details about the get_records element. To create a get_records element that defines how records are fetched from a module, including the criteria, selection behavior, and sorting, refer to the [Create Kiosk Get Records API](kiosks_get_records.yaml#$.paths./settings/kiosks/{kioskId}/get_records.post). Additional keys: not allowed |
get_record.id | string | Required within parent | Represents the unique identifier of the get_record configuration. Maximum length: 255 |
get_record.name | string | Required within parent | Represents the display name of the get_record configuration. Maximum length: 255 |
Create a kiosk state — request body — body states item details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for creating a kiosk screen state. Contains the screen_details object, which must include the elements array. Additional keys: not allowed |
screen_details | Model | Required within parent | Expand Create a kiosk state — request body — body states item details screen details screen details Configuration object for the UI screen. Specify the details related to the screen state. The screen state can contain buttons, fields, and components. |
Referenced models: Create a kiosk state — request body — body states item details screen details screen details
Create a kiosk state — request body — body states item details screen details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the UI screen configuration rendered to the kiosk user. Contains the elements array, optional buttons, layout width, title, and button alignment. Additional keys: not allowed |
button_align | string or null | Optional | The alignment of action buttons on the screen. Default value is right_to_left. Possible values: right_to_left - Buttons are aligned from right to left. left_to_right - Buttons are aligned from left to right. center - Buttons are aligned to the center. One of: right_to_left, left_to_right, center |
buttons | array or null | Optional | Represents the list of action buttons on the screen. Each button triggers a transition to another state. When provided, each button must include a prop_name and name. Maximum items: 10 |
buttons[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details buttons item |
elements | array | Required within parent | Specify the array of UI elements to be rendered on the screen. You can configure a maximum of 30 UI elements per screen. If this array is provided, it must contain at least one UI element. Maximum items: 30 |
elements[] | Model | Each item | Expand Create a kiosk state — request body — body states item details screen details screen details elements item |
title | string or null | Optional | Represents the display title shown at the top of the kiosk screen, providing contextual information about the screen's purpose. Maximum length: 255 |
width | string or null | Optional | Represents the visual width of the screen container. Controls layout and element alignment inside the screen. Possible values: 670px - Standard width layout. 1000px - Wide layout. Maximum length: 50 Pattern: ^(670px|1000px)$ |
Referenced models: Kiosk State — request body — body states item details screen details screen details buttons item, Create a kiosk state — request body — body states item details screen details screen details elements item
Create a kiosk state — request body — body states item details screen details screen details elements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single UI component rendered on the screen. The type field determines the element's structure, and the corresponding configuration object is required based on the type. Additional keys: not allowed |
data_hub | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item data hub Indicates that the UI element is a Queries component displayed on the screen. This allows the screen to fetch and display data from external sources. |
field | Model | Optional | Expand Create a kiosk state — request body — body states item details screen details screen details elements item field Configuration object describing a form input field that users can interact with on the screen. This object defines: field label data type validation rules UI presentation API mapping The kiosk runtime uses this configuration to render the correct input component and collect user input. |
get_record | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item get record Reference to a record retrieval operation called a get_record. This component fetches records from the CRM system and displays them within the screen. The records are fetched by using user-specified criteria. This should be given if a get_record component created anywhere else in the Kiosk is to be associated in the current screen. |
name | string or null | Optional | Represents the display name of the screen element. Maximum length: 255 |
open_record | boolean or null | Optional | Indicates whether clicking a record in the get_record component opens its detail view. Possible values: true - Clicking a record opens its detail view. false - Records are displayed without navigating to the detail view. |
selected_fields | array or null | Optional | Represents the list of fields to retrieve from the get_record component and display on the screen. Maximum items: 50 |
selected_fields[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details elements item selected fields item |
type | string | Required within parent | Represents the type of the screen element, which determines which UI component is rendered. Supported types include field, screen_field, get_records, text, zia_insights, data_hubs, and created_records. One of: screen_field, field, get_records, text, zia_insights, data_hubs, created_records |
ui_type | integer or null | Optional | Represents the numeric identifier of the UI component type used by the rendering engine to determine which widget to display. Format: int32 |
value | JSON | Optional | Represents the content of the element for text-type elements. Null for other element types such as field, screen_field, and get_records. |
value (anyOf 1) | string | Alternative | Represents the string content value for text-type screen elements. Maximum length: 2000 |
value (anyOf 2) | boolean | Alternative | Represents the Boolean predefined value for checkbox-type screen fields. |
value (anyOf 3) | null | Alternative | Represents the null value for screen elements that do not have a predefined value. |
zia_insight | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item zia insight Represents an AI-powered insight component. This widget can display predictions, recommendations, or analytics generated by the Zia AI engine. |
$ (allOf 1) | JSON | All variants apply | Represents the conditional schema constraint that requires the field object when the element type is field. |
$ (allOf 2) | JSON | All variants apply | Represents the conditional schema constraint that requires selected_fields when the element type is get_records. |
$ (allOf 3) | JSON | All variants apply | Represents the conditional schema constraint that requires the get_record object when the element type is get_records. |
$ (allOf 4) | JSON | All variants apply | Represents the conditional schema constraint that requires the data_hub object when the element type is data_hubs. |
$ (allOf 5) | JSON | All variants apply | Represents the conditional schema constraint that requires the zia_insight object when the element type is zia_insights. |
Referenced models: Kiosk State — request body — body states item details screen details screen details elements item data hub, Create a kiosk state — request body — body states item details screen details screen details elements item field, Kiosk State — request body — body states item details screen details screen details elements item get record, Kiosk State — request body — body states item details screen details screen details elements item selected fields item, Kiosk State — request body — body states item details screen details screen details elements item zia insight
Create a kiosk state — request body — body states item details screen details screen details elements item field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the form input field configuration for a kiosk screen. Defines the field label, data type, API name, UI type, validation rules, and additional type-specific properties. Additional keys: not allowed |
_merge_field | string or null | Optional | Represents a dynamic data binding expression that populates the field from an external source. Three formats are supported: record field reference, CRM module field reference, and kiosk screen field reference. Maximum length: 500 |
_pick_list_type | string | Optional | Represents the source of picklist values.Possible values: local - Values are defined inline within the screen field. global_set - Values are sourced from a shared global picklist. One of: local, global_set |
allow_multiple_upload | boolean or null | Optional | Indicates whether multiple file uploads are allowed for the field. Possible values: true - Multiple file uploads are allowed. false - Only a single file upload is allowed. |
api_name | string or null | Optional | Represents the unique API name used to map the field to backend data structures, workflow variables, and subsequent kiosk states. Maximum length: 50 |
currency | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item field currency It defines the currency field's properties. Says how the value should be saved based on decimal places, precision, and rounding option. |
data_type | string or null | Optional | Represents the data format expected for the field, controlling both frontend input validation and backend data interpretation. One of: text, fileupload, userlookup, multiselectpicklist, picklist, datetime, date, email, boolean, currency, integer, phone, textarea, multichoicelookup, lookup, website, percent, double |
decimal_place | integer or null | Optional | Represents the number of digits after the decimal point for numeric fields. For currency fields, this value must be greater than the precision value in the currency configuration. Format: int32 |
field_label | string or null | Optional | Represents the display label shown to the user for the input field. This label is visible on the screen but does not affect backend storage. Maximum length: 255 Pattern: [0-9a-zA-Z_\\-\\.\\|\\$\\&@\\(\\)\\?\\,\\'\\/\\!\\P{InBasicLatin}\\s]+ |
global_picklist | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item field global picklist Reference to a globally defined picklist. |
length | integer or null | Optional | Represents the maximum number of characters or digits allowed for the field. For file upload fields, the value must be 1 or 5. Format: int32 |
number_separator | boolean or null | Optional | Indicates whether a thousands separator is displayed for values in this field.Possible values: true - A thousands separator is displayed. false - No thousands separator is displayed. |
pick_list_values | array or null | Optional | Represents the list of options available for selection in a picklist field. Maximum items: 1000 |
pick_list_values[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details elements item field pick list values item |
read_only | boolean or null | Optional | Indicates whether the field is read-only.Possible values: true - The field is displayed but cannot be edited by the user. false - The user can input or modify the value. |
required | boolean or null | Optional | Indicates whether a value is required before the screen can proceed.Possible values:true - A value must be provided.false - The field may be left empty. |
tooltip | Model | Optional | Expand Create a kiosk state — request body — body states item details screen details screen details elements item field tooltip Defines additional help information associated with the field. Tooltips provide contextual guidance to users explaining what data should be entered. |
ui_type | integer or null | Optional | Represents the numeric identifier of the UI widget type, used by the rendering engine to determine which component to display. Format: int32 |
value | boolean or null | Optional | Represents a predefined value for the field. For checkbox fields, this is true when the checkbox is checked by default and false when unchecked. |
$ (allOf 1) | JSON | All variants apply | description for allOf nested |
$ (allOf 2) | JSON | All variants apply | description for allOf nested |
$ (allOf 3) | JSON | All variants apply | description for allOf nested |
$ (allOf 4) | JSON | All variants apply | description for allOf nested |
$ (allOf 5) | JSON | All variants apply | description for allOf nested |
$ (allOf 6) | JSON | All variants apply | description for allOf nested |
$ (allOf 7) | JSON | All variants apply | description for allOf nested |
$ (allOf 8) | JSON | All variants apply | description for allOf nested |
$ (allOf 9) | JSON | All variants apply | description for allOf nested |
$ (allOf 10) | JSON | All variants apply | description for allOf nested |
$ (allOf 11) | JSON | All variants apply | description for allOf nested |
$ (allOf 12) | JSON | All variants apply | description for allOf nested |
Referenced models: Kiosk State — request body — body states item details screen details screen details elements item field currency, Kiosk State — request body — body states item details screen details screen details elements item field global picklist, Kiosk State — request body — body states item details screen details screen details elements item field pick list values item, Create a kiosk state — request body — body states item details screen details screen details elements item field tooltip
Create a kiosk state — request body — body states item details screen details screen details elements item field tooltip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the tooltip configuration for a screen field. Contains the tooltip type and the text displayed to the user. Additional keys: not allowed |
name | string | Required within parent | Represents the type of tooltip presentation for the field. Possible values: info_icon - Displays an information icon next to the field. static_text - Displays informational text next to the field. One of: info_icon, static_text |
value | string | Required within parent | The tooltip text shown to the user. The maximum characters allowed for info_icon is 255 chars and for static_text is 32 chars. Maximum length: 500 |
Create a kiosk state — request body — body states item from transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the transition trigger that activates a kiosk state. Contains the unique identifier of the transition edge that leads into the state. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the transition that activates this kiosk state. Transitions arise when a button activates on a previous screen, a decision node produces a routing path, or an action completes and triggers the next step. To get details about transitions, refer to the [Get Kiosk States API.](kiosks_states.yaml#$.paths./settings/kiosks/{kioskId}/states.get) Maximum length: 19 |
Create a kiosk state — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response returned after a kiosk state creation. Additional keys: not allowed |
states | array | Optional | Represents the array of operation result objects for the created kiosk states. Maximum items: 1 |
states[] | Model | Each item | Expand Delete a kiosk state — response body — states |
Referenced models: Delete a kiosk state — response body — states
Delete a kiosk state — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response returned after a kiosk state deletion. Additional keys: not allowed |
states | Model | Optional | Expand Delete a kiosk state — response body — states |
Referenced models: Delete a kiosk state — response body — states
Delete a kiosk state — response body — states
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the operation result for a single kiosk state in a create or update response. Contains the result code, status, message, and state details. Additional keys: not allowed |
code | string | Optional | Represents the result code for the operation on this state. Maximum length: 255 |
details | Model | Optional | Expand Delete a kiosk state — response body — states details |
message | string | Optional | Represents the result message for the operation on this state. Maximum length: 255 |
status | string | Optional | Represents the result status for the operation on this state. Maximum length: 255 |
Referenced models: Delete a kiosk state — response body — states details
Delete a kiosk state — response body — states details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of a state operation result. Contains the unique identifier and resource identifier of the created or updated kiosk state. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk state created or updated. Maximum length: 255 |
rid | string | Optional | Represents the resource identifier of the kiosk state. Format: uuid Maximum length: 255 |
Get a specific kiosk state by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for retrieving a specific kiosk state. The state details structure varies by type and can be a screen, decision, action, or get_records state. Additional keys: not allowed |
states | array | Required within parent | Represents the list of states returned for the kiosk. Maximum items: 1 |
states[] | JSON | Each item | Represents a single kiosk state, either a screen, decision, action, or get_records state, with its full configuration details. |
states[] (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen |
states[] (anyOf 2) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision |
states[] (anyOf 3) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: action |
states[] (anyOf 4) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: get records |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: action, Get a specific kiosk state by ID — response body — states / item / type: decision, Get a specific kiosk state by ID — response body — states / item / type: get records, Get a specific kiosk state by ID — response body — states / item / type: screen
Get a specific kiosk state by ID — response body — states / item / type: action
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single action state returned by the get-by-ID endpoint, including the action configuration, associated fields, transitions, and configured properties. Additional keys: not allowed |
associated_fields | JSON | Required within parent | |
associated_fields (anyOf 1) | array | Alternative | Represents the list of fields associated with the action state. Maximum items: 25 |
associated_fields (anyOf 1)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
associated_fields (anyOf 2) | null | Alternative | Represents the list of fields associated with the action state. Maximum items: 25 |
associated_fields (anyOf 2)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
configured_properties | JSON | Optional | |
configured_properties (anyOf 1) | object | Alternative | Represents additional configured properties returned for the action state. Additional keys: allowed |
configured_properties (anyOf 2) | null | Alternative | Represents additional configured properties returned for the action state. Additional keys: allowed |
details | object | Required within parent | Represents the detailed action configuration for the kiosk action state. Additional keys: allowed |
from_transition | Model | Optional | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition Transition that leads into this action state. |
id | string | Required within parent | Represents the unique identifier of the kiosk action state. Maximum length: 255 |
name | string | Required within parent | Represents the name of the kiosk action state. Maximum length: 255 |
transitions | array | Required within parent | Represents the list of outgoing transitions configured for the kiosk action state. Maximum items: 25 |
transitions[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition |
type | string | Required within parent | Represents the type of the kiosk state. Known values: action Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item, Get a specific kiosk state by ID — response body — states / item / type: action from transition
Get a specific kiosk state by ID — response body — states / item / type: action from transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an outgoing transition from a kiosk state returned in a GET response. Contains the transition ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the outgoing transition. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the outgoing transition. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: decision
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single decision state returned by the get-by-ID endpoint, including its configuration, associated fields, transitions, and configured properties. Additional keys: not allowed |
associated_fields | array | Required within parent | Represents the list of fields associated with the decision state, including the paths that reference each field. Maximum items: 30 |
associated_fields[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item |
configured_properties | array | Required within parent | Represents the list of configured properties associated with the decision state. Maximum items: 30 |
configured_properties[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item |
details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details |
from_transition | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen from transition |
id | string | Required within parent | Represents the unique identifier of the kiosk decision state. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk decision state. Maximum length: 255 |
transitions | array | Required within parent | Represents the list of outgoing transitions configured for the decision state. Maximum items: 30 |
transitions[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: decision transitions item |
type | string | Required within parent | Represents the type of the kiosk state. Always 'decision' for this schema. Known values: decision Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item, Get a specific kiosk state by ID — response body — states / item / type: decision transitions item, Get a specific kiosk state by ID — response body — states / item / type: screen from transition, Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item, Get a specific kiosk state by ID — response body — states / item / type: decision details
Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field associated with a decision state, including its API name, unique identifier, and the decision paths that reference it. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field associated with the decision state. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the field associated with the decision state. Maximum length: 255 |
path_details | array | Optional | Represents the list of decision paths that reference this associated field. Maximum items: 11 |
path_details[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item path details item |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item path details item
Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item path details item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to a decision path within an associated field's path_details list. Contains the path ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the decision path referenced by the associated field. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the decision path referenced by the associated field. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a configured property associated with a decision state, including its type and detail properties. Additional keys: not allowed |
details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details |
type | string | Required within parent | Represents the type of the configured property associated with the decision state. Known values: _merge_field, recipients Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details
Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of a configured property associated with a kiosk state. Contains the name of the configured property. Additional keys: not allowed |
component_name | string | Optional | Field: component_name. Associated component reference. Maximum length: 255 |
name | string | Required within parent | Represents the name of the configured property detail. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: decision details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details object for a decision state returned in a GET response. Contains the path definitions configured for the decision. Additional keys: not allowed |
path_details | array | Required within parent | Represents the list of decision paths configured for the decision state. Maximum items: 6 |
path_details[] | JSON | Each item | Represents a single decision path, including its identifier, display name, default flag, and filter conditions. |
path_details[] (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name
Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a decision path returned in a GET response, including the path ID, name, default flag, and filter conditions. Additional keys: not allowed |
default | boolean | Required within parent | Indicates whether this path is the default fallback path. Possible values: true - This path is the default fallback and is taken if no other conditions are satisfied. false - This path requires filter conditions to be met. |
filter_conditions | JSON | Required within parent | |
filter_conditions (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value Field: filter_conditions |
filter_conditions (anyOf 2) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value Field: filter_conditions |
id | string | Required within parent | Represents the unique identifier of the decision path. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the decision path. Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value
Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the filter conditions for a decision path returned in a GET response, including the logical pattern and list of criteria groupings. Additional keys: not allowed |
$ (anyOf 1).criteria_groupings | array | Required within parent | Represents the list of conditions evaluated as part of the decision state. Maximum items: 5 |
$ (anyOf 1).criteria_groupings[] | JSON | Each item | Represents a single condition grouping within the decision filter. Each entry defines the data source, evaluation value, and optional criteria details. |
$ (anyOf 1).criteria_groupings[] (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping |
$ (anyOf 1).criteria_groupings[] (anyOf 2) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping Nested |
$ (anyOf 1).pattern | string | Required within parent | Represents the logical expression that combines criteria groupings. Sequence numbers in the pattern reference the corresponding groupings, combined using logical operators such as and and or. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents the filter conditions for a decision path returned in a GET response, including the logical pattern and list of criteria groupings. Additional keys: not allowed |
$ (anyOf 2).criteria_groupings | array | Required within parent | Represents the list of conditions evaluated as part of the decision state. Maximum items: 5 |
$ (anyOf 2).criteria_groupings[] | JSON | Each item | Represents a single condition grouping within the decision filter. Each entry defines the data source, evaluation value, and optional criteria details. |
$ (anyOf 2).criteria_groupings[] (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping |
$ (anyOf 2).criteria_groupings[] (anyOf 2) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping Nested |
$ (anyOf 2).pattern | string | Required within parent | Represents the logical expression that combines criteria groupings. Sequence numbers in the pattern reference the corresponding groupings, combined using logical operators such as and and or. Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping, Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping Nested
Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single condition grouping returned in a GET response for a decision state. Contains the sequence number, data source type, evaluation value, and criteria details. Additional keys: not allowed |
criteria | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria Criteria for this grouping in the GET response. Automatically resolves to either a simple field-value comparison or a nested grouped condition. Defined in Criterion.json. |
resource | null | Required within parent | Represents the resource used as the data source when evaluating the condition. This is null when the condition type does not reference an external record. |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Represents the position index of the condition within the criteria groupings list, referenced by the logical pattern expression. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Represents the data source type used for condition evaluation. Indicates whether the condition evaluates a field from the current record, a get_record result, a kiosk screen field, a data hub, a created record, or a loop record. Maximum length: 255 |
value | JSON | Required within parent | |
value (anyOf 1) | string | Alternative | Represents whether the evaluated field must contain data.\ nPossible values:\n${NOTEMPTY} - The field must have a value.\n${EMPTY} - The field must be empty. Maximum length: 255 |
value (anyOf 2) | null | Alternative | Represents whether the evaluated field must contain data.\ nPossible values:\n${NOTEMPTY} - The field must have a value.\n${EMPTY} - The field must be empty. Maximum length: 255 |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item criteria
Get a specific kiosk state by ID — response body — states / item / type: decision details path details item default, filter conditions, id, name filter conditions value criteria groupings, pattern criteria groupings item criteria, resource, sequence number, type, value — GETDecision Criteria Grouping Nested
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a nested condition grouping returned in a GET response for a decision state. Contains the sequence number, data source type, evaluation value, resource reference, and criteria details. Additional keys: not allowed |
criteria | Model | Optional | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria Criteria for this grouping in the GET response. Automatically resolves to either a simple field-value comparison or a nested grouped condition. Defined in Criterion.json. |
resource | object | Required within parent | Represents the resource used as the data source when evaluating the condition. Additional keys: not allowed |
resource.id | string | Required within parent | Represents the unique identifier of the resource referenced by the decision condition. Maximum length: 255 |
resource.name | string | Required within parent | Represents the display name of the resource referenced by the decision condition. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Represents the position index of the condition within the criteria groupings list, referenced by the logical pattern expression. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Represents the data source type used for condition evaluation. Maximum length: 255 |
value | string | Required within parent | Represents whether the evaluated field must contain data.\ nPossible values:\n${NOTEMPTY} - The field must have a value.\n${EMPTY} - The field must be empty. Maximum length: 255 |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item criteria
Get a specific kiosk state by ID — response body — states / item / type: decision transitions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an outgoing transition from a decision state returned in a GET response. Contains the transition ID, display name, and default flag. Additional keys: not allowed |
default | boolean | Required within parent | Indicates whether this transition corresponds to the default fallback decision path. Possible values: true - This is the default fallback transition. false - This transition requires filter conditions to be met. |
id | string | Required within parent | Represents the unique identifier of the decision transition. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the decision transition. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: get records
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single get_records state returned by the get-by-ID endpoint. Contains the state configuration, associated fields, transitions, and the linked get_record component details. Additional keys: not allowed |
associated_fields | JSON | Required within parent | |
associated_fields (anyOf 1) | array | Alternative | Represents the list of fields associated with the get_records state. Maximum items: 25 |
associated_fields (anyOf 1)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
associated_fields (anyOf 2) | null | Alternative | Represents the list of fields associated with the get_records state. Maximum items: 25 |
associated_fields (anyOf 2)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
configured_properties | JSON | Optional | |
configured_properties (anyOf 1) | object | Alternative | Represents additional configured properties returned for the get_records state. This is typically null for get_records states. Additional keys: allowed |
configured_properties (anyOf 2) | null | Alternative | Represents additional configured properties returned for the get_records state. This is typically null for get_records states. Additional keys: allowed |
details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: get records details Configuration details containing the get_record reference. |
from_transition | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen from transition Transition that leads into this get_records state. |
id | string | Required within parent | Represents the unique identifier of the kiosk get_records state. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk get_records state. Maximum length: 255 |
transitions | JSON | Required within parent | |
transitions (anyOf 1) | array | Alternative | Represents the list of outgoing transitions from the get_records state. Maximum items: 25 |
transitions (anyOf 1)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition |
transitions (anyOf 2) | null | Alternative | Represents the list of outgoing transitions from the get_records state. Maximum items: 25 |
transitions (anyOf 2)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition |
type | string | Required within parent | Represents the type of the kiosk state. Always 'get_records' for this schema. Known values: get_records |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item, Get a specific kiosk state by ID — response body — states / item / type: screen from transition, Get a specific kiosk state by ID — response body — states / item / type: get records details, Get a specific kiosk state by ID — response body — states / item / type: action from transition
Get a specific kiosk state by ID — response body — states / item / type: get records details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details object for a get_records state returned in a GET response. Contains a reference to the associated get_record component. Additional keys: not allowed |
get_record | object | Required within parent | Represents the get_record component associated with the get_records state. Additional keys: not allowed |
get_record.id | string | Required within parent | Represents the unique identifier of the get_record component. Maximum length: 255 |
get_record.name | string | Required within parent | Represents the display name of the get_record component. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single screen state returned by the get-by-ID endpoint, including its configuration, associated fields, transitions, and configured properties. Additional keys: not allowed |
associated_fields | array | Required within parent | Represents the list of fields associated with the screen state. Maximum items: 2 |
associated_fields[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
configured_properties | JSON | Required within parent | |
configured_properties (anyOf 1) | array | Alternative | Represents the configured properties associated with the screen state. Maximum items: 2 |
configured_properties (anyOf 1)[] | Model | Each item | Expand Get all states of a kiosk — response body — states states item configured properties null item |
configured_properties (anyOf 2) | null | Alternative | Represents the configured properties associated with the screen state. Maximum items: 2 |
configured_properties (anyOf 2)[] | Model | Each item | Expand Get all states of a kiosk — response body — states states item configured properties null item |
details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details |
from_transition | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen from transition |
id | string | Required within parent | Represents the unique identifier of the kiosk screen state. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk screen state. Maximum length: 255 |
transitions | array | Required within parent | Represents the list of outgoing transitions configured for the screen state. Maximum items: 1 |
transitions[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition |
type | string | Required within parent | Represents the type of the kiosk state. Always 'screen' for this schema. Known values: screen Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item, Get a specific kiosk state by ID — response body — states / item / type: screen from transition, Get a specific kiosk state by ID — response body — states / item / type: action from transition, Get all states of a kiosk — response body — states states item configured properties null item, Get a specific kiosk state by ID — response body — states / item / type: screen details
Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field associated with a kiosk state, including its API name and unique identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field associated with the kiosk state. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the field associated with the kiosk state. Maximum length: 255 |
type | string | Optional | Field: type. Present only for screen state associated fields. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details object for a screen state returned in a GET response. Contains the screen configuration including elements, buttons, and layout properties. Additional keys: not allowed |
screen_details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the screen configuration returned in a GET response for a screen state. Contains the UI elements, buttons, width, title, and button alignment. Additional keys: not allowed |
button_align | string | Required within parent | Represents the alignment direction of action buttons within the screen footer. Known values: right_to_left, left_to_right, center Maximum length: 255 |
buttons | array | Required within parent | Represents the list of action buttons configured on the screen. Maximum items: 1 |
buttons[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details buttons item |
elements | array | Required within parent | Represents the list of UI components rendered on the screen, ordered from top to bottom. Maximum items: 30 |
elements[] | JSON | Each item | Represents a single UI component on the screen, such as a form field, get_record display, text element, or data hub component. |
elements[] (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item type, value |
elements[] (anyOf 2) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value |
elements[] (anyOf 3) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Field Element |
elements[] (anyOf 4) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Currency Field Element |
elements[] (anyOf 5) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Picklist Field Element |
elements[] (anyOf 6) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value |
title | string | Required within parent | Represents the display title shown at the top of the screen. Maximum length: 255 |
width | string | Required within parent | Represents the visual width of the screen container. Known values: 670px, 1000px Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details buttons item, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item type, value, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Currency Field Element, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Field Element, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Picklist Field Element
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details buttons item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a screen button returned in a GET response. Contains the button ID, display name, and style type. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the screen button. Maximum length: 255 |
name | string | Required within parent | Represents the display label of the screen button shown to the user. Maximum length: 255 |
prop_name | string | Required within parent | Represents the style type of the button, which determines its visual appearance and behavior. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a data hub element wrapper returned in a GET response for a screen state. Contains the element type and data hub configuration. Additional keys: not allowed |
data_hub | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub |
type | string | Required within parent | Represents the type of the screen element. Always 'data_hubs' for data hub elements. Maximum length: 255 |
value | null | Required within parent | Represents the element value. Null for data hub elements. |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a data hub component returned in a GET response for a screen state. Contains the component ID, name, selected fields, module reference, and selection details. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the data hub component. Maximum length: 255 |
module | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub module |
name | string | Required within parent | Represents the display name of the data hub component. Maximum length: 255 |
selected_fields | array | Required within parent | Represents the list of fields selected from the data hub query to display on the screen. Maximum items: 10 |
selected_fields[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selected fields item |
selection_details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selection details |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selected fields item, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub module, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selection details
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM module reference returned in a GET response, including the module's API name and unique identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the CRM module. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the CRM module. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selected fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field selected from a get_record or data hub component to display on the screen. Contains the field's API name and unique identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the field selected from the get_record component to display on the screen. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the field selected from the get_record component. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the selection details for a data hub component, including the selection type, result type, limit, and range. Additional keys: not allowed |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | Represents the maximum number of records to retrieve in the data hub query. Format: int32 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range | JSON | Required within parent | |
range (anyOf 1) | JSON | Alternative | |
range (anyOf 1) (anyOf 1) | integer | Alternative | Represents the record range for the data hub query result. Format: int32 |
range (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range (anyOf 2) | null | Alternative | Represents the record range for the data hub query result. Format: int32 |
result_type | string | Required within parent | Represents the result type of the data hub query, indicating whether the query returns a single record or a list of records. Maximum length: 255 |
selection_type | JSON | Required within parent | |
selection_type (anyOf 1) | string | Alternative | Represents the selection method used for the data hub query. Maximum length: 255 |
selection_type (anyOf 2) | null | Alternative | Represents the selection method used for the data hub query. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field currency value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the currency configuration of a screen field returned in a GET response. Contains the rounding option and precision. Additional keys: not allowed |
$ (anyOf 1).precision | JSON | Required within parent | |
$ (anyOf 1).precision (anyOf 1) | integer | Alternative | Represents the number of digits after the decimal point for the currency field value. Format: int32 |
$ (anyOf 1).precision (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).rounding_option | string | Required within parent | Represents the rounding method applied to the currency field value. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents the currency configuration of a screen field returned in a GET response. Contains the rounding option and precision. Additional keys: not allowed |
$ (anyOf 2).precision | JSON | Required within parent | |
$ (anyOf 2).precision (anyOf 1) | integer | Alternative | Represents the number of digits after the decimal point for the currency field value. Format: int32 |
$ (anyOf 2).precision (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 2).rounding_option | string | Required within parent | Represents the rounding method applied to the currency field value. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a picklist option returned in a GET response. Contains the option ID, display value, actual value, and sequence number. Additional keys: not allowed |
actual_value | string | Required within parent | Represents the value stored internally when this picklist option is selected. Maximum length: 255 |
display_value | string | Required within parent | Represents the text displayed to the user for this picklist option. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the picklist option. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Represents the display order of the picklist option within the list. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Basic Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a basic form field returned in a GET response for a screen state. Contains field metadata including API name, data type, UI type, display label, read-only flag, and required flag. Additional keys: not allowed |
_merge_field | null | Required within parent | Represents a dynamic data binding expression that populates the field from an external source. Three formats are supported: record field, CRM module field, and kiosk screen field. Null when no merge field is configured. |
_pick_list_type | null | Required within parent | Represents the picklist source type. Null for non-picklist fields. |
allow_multiple_upload | null | Required within parent | Indicates whether multiple file uploads are allowed. Null for field types that do not support file upload. |
api_name | string | Required within parent | Represents the API name of the screen field. Maximum length: 255 |
currency | null | Required within parent | Represents the currency configuration of the field. Null for non-currency fields. |
data_type | string | Required within parent | Represents the data type of the screen field, such as text, textarea, phone, email, currency, or picklist. Maximum length: 255 |
decimal_place | null | Required within parent | Represents the number of decimal places for numeric fields. Null for non-numeric fields. |
field_label | string | Required within parent | Represents the display label of the screen field shown to the user. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the screen field. Maximum length: 255 |
length | JSON | Required within parent | |
length (anyOf 1) | JSON | Alternative | |
length (anyOf 1) (anyOf 1) | integer | Alternative | Represents the maximum number of characters or digits allowed for the field. Null for field types that do not enforce a length constraint. Format: int32 |
length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
length (anyOf 2) | null | Alternative | Represents the maximum number of characters or digits allowed for the field. Null for field types that do not enforce a length constraint. Format: int32 |
number_separator | boolean | Required within parent | Indicates whether a thousands separator is displayed for numeric values.\nPossible values:\ntrue - A thousands separator is displayed.\ nfalse - No thousands separator is displayed. |
pick_list_values | null | Required within parent | Represents the list of picklist option values. Null for non-picklist fields. |
read_only | boolean | Required within parent | Indicates whether the field is read-only.\nPossible values:\ ntrue - The field is displayed but cannot be edited by the user.\nfalse - The user can input or modify the value. |
required | boolean | Required within parent | Indicates whether a value is required before the screen can proceed.\nPossible values:\ntrue - A value must be provided.\nfalse - The field may be left empty. |
tooltip | null | Required within parent | Represents the tooltip configuration for the field. Null when no tooltip is configured. |
ui_type | JSON | Required within parent | |
ui_type (anyOf 1) | integer | Alternative | Represents the numeric identifier of the UI widget type used to render the field. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Currency Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a currency form field returned in a GET response for a screen state. Contains currency-specific metadata including decimal places, precision, and rounding option. Additional keys: not allowed |
_merge_field | null | Required within parent | Represents a dynamic data binding expression that populates the field from an external source. Three formats are supported: record field, CRM module field, and kiosk screen field. Null when no merge field is configured. |
_pick_list_type | null | Required within parent | Represents the picklist source type. Null for currency fields. |
allow_multiple_upload | null | Required within parent | Indicates whether multiple file uploads are allowed. Null for currency fields. |
api_name | string | Required within parent | Represents the API name of the currency screen field. Maximum length: 255 |
currency | JSON | Required within parent | |
currency (anyOf 1) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field currency value Field: currency |
currency (anyOf 2) | Model | Alternative | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field currency value Field: currency |
data_type | string | Required within parent | Represents the data type of the field. Always 'currency' for this schema. Maximum length: 255 |
decimal_place | JSON | Required within parent | |
decimal_place (anyOf 1) | integer | Alternative | Represents the number of decimal places configured for the currency field. Format: int32 |
decimal_place (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
field_label | string | Required within parent | Represents the display label of the currency field shown to the user. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the currency screen field. Maximum length: 255 |
length | JSON | Required within parent | |
length (anyOf 1) | integer | Alternative | Represents the maximum number of digits allowed for the currency field. Format: int32 |
length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_separator | boolean | Required within parent | Indicates whether a thousands separator is displayed for the currency field value.\nPossible values:\ntrue - A thousands separator is displayed.\nfalse - No thousands separator is displayed. |
pick_list_values | null | Required within parent | Represents the list of picklist option values. Null for currency fields. |
read_only | boolean | Required within parent | Indicates whether the currency field is read-only.\nPossible values:\ntrue - The field is displayed but cannot be edited.\nfalse - The user can modify the value. |
required | boolean | Required within parent | Indicates whether a value is required in the currency field before the screen can proceed.\nPossible values:\ntrue - A value must be provided.\nfalse - The field may be left empty. |
tooltip | null | Required within parent | Represents the tooltip configuration for the currency field. Null when no tooltip is configured. |
ui_type | JSON | Required within parent | |
ui_type (anyOf 1) | integer | Alternative | Represents the numeric identifier of the UI widget type used to render the currency field. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field currency value
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Picklist Field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a picklist form field returned in a GET response for a screen state. Contains the field metadata including the picklist values and source type. Additional keys: not allowed |
_merge_field | null | Required within parent | Represents a dynamic data binding expression that populates the field from an external source. Three formats are supported: record field, CRM module field, and kiosk screen field. Null when no merge field is configured. |
_pick_list_type | JSON | Required within parent | |
_pick_list_type (anyOf 1) | string | Alternative | Represents the source of picklist values.\nPossible values:\ nlocal - Values are defined inline within the screen field.\nglobal_set - Values are sourced from a shared global picklist. Maximum length: 255 |
_pick_list_type (anyOf 2) | null | Alternative | Represents the source of picklist values.\nPossible values:\ nlocal - Values are defined inline within the screen field.\nglobal_set - Values are sourced from a shared global picklist. Maximum length: 255 |
allow_multiple_upload | null | Required within parent | Indicates whether multiple file uploads are allowed. Null for picklist fields. |
api_name | string | Required within parent | Represents the API name of the picklist screen field. Maximum length: 255 |
currency | null | Required within parent | Represents the currency configuration of the field. Null for picklist fields. |
data_type | string | Required within parent | Represents the data type of the screen field, such as picklist or multiselectpicklist. Maximum length: 255 |
decimal_place | null | Required within parent | Represents the number of decimal places for the field. Null for picklist fields. |
field_label | string | Required within parent | Represents the display label of the picklist field shown to the user. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the picklist screen field. Maximum length: 255 |
length | JSON | Required within parent | |
length (anyOf 1) | integer | Alternative | Represents the maximum number of options allowed for the picklist field. Format: int32 |
length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_separator | boolean | Required within parent | Indicates whether a thousands separator is displayed. Not applicable for picklist fields. |
pick_list_values | array | Required within parent | Represents the list of picklist options available for selection. Maximum items: 3 |
pick_list_values[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field pick list values item |
read_only | boolean | Required within parent | Indicates whether the picklist field is read-only.\nPossible values:\ntrue - The field is displayed but cannot be edited.\nfalse - The user can select a value. |
required | boolean | Required within parent | Indicates whether a selection is required before the screen can proceed.\nPossible values:\ntrue - A selection must be made.\nfalse - The field may be left empty. |
tooltip | null | Required within parent | Represents the tooltip configuration for the picklist field. Null when no tooltip is configured. |
ui_type | JSON | Required within parent | |
ui_type (anyOf 1) | integer | Alternative | Represents the numeric identifier of the UI widget type used to render the picklist field. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field pick list values item
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Currency Field Element
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a currency field element wrapper returned in a GET response for a screen state. Contains the element type and field configuration. Additional keys: not allowed |
field | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Currency Field |
type | string | Required within parent | Represents the type of the screen element. Always 'field' for currency field elements. Maximum length: 255 |
value | null | Required within parent | Represents the element value. Null for field-type elements. |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Currency Field
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Field Element
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a basic field element wrapper returned in a GET response for a screen state. Contains the element type and field configuration. Additional keys: not allowed |
field | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Basic Field |
type | string | Required within parent | Represents the type of the screen element. Always 'field' for basic field elements. Maximum length: 255 |
value | null | Required within parent | Represents the element value. Null for field-type elements. |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Basic Field
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value — GETScreen Picklist Field Element
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a picklist field element wrapper returned in a GET response for a screen state. Contains the element type and field configuration. Additional keys: not allowed |
field | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Picklist Field |
type | string | Required within parent | Represents the type of the screen element. Always 'field' for picklist field elements. Maximum length: 255 |
value | null | Required within parent | Represents the element value. Null for picklist field elements. |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item field, type, value field — GETScreen Picklist Field
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a get_record element wrapper returned in a GET response for a screen state. Contains the element type, UI type, and get_record configuration. Additional keys: not allowed |
get_record | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value get record |
type | string | Required within parent | Represents the type of the screen element. Always 'get_records' for get_record elements. Maximum length: 255 |
ui_type | JSON | Required within parent | |
ui_type (anyOf 1) | integer | Alternative | Represents the numeric identifier of the UI widget type used to render the get_record element. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
value | null | Required within parent | Represents the element value. Null for get_record elements. |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value get record
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a get_record component returned in a GET response for a screen state. Contains the component ID, name, selected fields, module reference, open_record flag, and selection details. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the get_record component displayed on the screen. Maximum length: 255 |
module | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub module |
name | string | Required within parent | Represents the display name of the get_record component shown on the screen. Maximum length: 255 |
open_record | boolean | Required within parent | Indicates whether clicking a record in the get_record component opens its detail view.\nPossible values:\ntrue - Clicking a record opens its detail view.\nfalse - Records are displayed without opening the detail view. |
selected_fields | array | Required within parent | Represents the list of fields retrieved from the get_record component and displayed on the screen. Maximum items: 2 |
selected_fields[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selected fields item |
selection_details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value get record selection details |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub selected fields item, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item data hub, type, value data hub module, Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value get record selection details
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item get record, type, ui type, value get record selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the selection configuration for a get_record or data hub component on the screen. Contains the selection type, result type, limit, and range. Additional keys: not allowed |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | Represents the maximum number of records to retrieve from the get_record component. Format: int32 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range | JSON | Required within parent | |
range (anyOf 1) | integer | Alternative | Represents the record range for the get_record retrieval. Format: int32 |
range (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_type | string | Required within parent | Represents the result type of the get_record retrieval, indicating whether the query returns a single record or a list of records. Maximum length: 255 |
selection_type | string | Required within parent | Represents the selection method used to retrieve records in the get_record component. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen details screen details elements item type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a text element returned in a GET response for a screen state. Contains the element type and text content. Additional keys: not allowed |
type | string | Required within parent | Represents the type of the screen element. Always 'text' for text elements. Maximum length: 255 |
value | string | Required within parent | Represents the text content displayed in the text element on the screen. Maximum length: 255 |
Get a specific kiosk state by ID — response body — states / item / type: screen from transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the transition through which the current state is reached. This object contains the transition's name and ID. This field is null for the start state. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the transition that leads into this kiosk state. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the transition that leads into this kiosk state. Maximum length: 255 |
Get all states of a kiosk — response body — states
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for retrieving all states associated with a kiosk. Contains a list of lightweight state entries with their basic metadata. Additional keys: not allowed |
states | array | Required within parent | The response body contains a JSON object with a states array that lists all the states configured in the specified Kiosk. Maximum items: 150 |
states[] | Model | Each item | Expand Get all states of a kiosk — response body — states states item |
Referenced models: Get all states of a kiosk — response body — states states item
Get all states of a kiosk — response body — states states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a lightweight kiosk state entry returned by the get all states operation. Includes the state ID, name, type, transitions, associated fields, and summary details. Additional keys: not allowed |
associated_fields | JSON | Optional | |
associated_fields (anyOf 1) | array | Alternative | Represents the state type, indicating whether the state is a screen, decision, action, or get_records state. Below are the possible values for the action state. **Possible values:** create_record quick_create_record convert open_record open_link add_meeting schedule_call assign_owner add_tags remove_tags field_updates tasks email_notifications webhooks For get_records ,decision , start_state and end_state states, this field is null. Maximum items: 25 |
associated_fields (anyOf 1)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
associated_fields (anyOf 2) | null | Alternative | Represents the state type, indicating whether the state is a screen, decision, action, or get_records state. Below are the possible values for the action state. **Possible values:** create_record quick_create_record convert open_record open_link add_meeting schedule_call assign_owner add_tags remove_tags field_updates tasks email_notifications webhooks For get_records ,decision , start_state and end_state states, this field is null. Maximum items: 25 |
associated_fields (anyOf 2)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item |
configured_properties | JSON | Optional | |
configured_properties (anyOf 1) | array | Alternative | Merge fields and dynamic references. Returned only when the include parameter is used. Maximum items: 50 |
configured_properties (anyOf 1)[] | Model | Each item | Expand Get all states of a kiosk — response body — states states item configured properties null item |
configured_properties (anyOf 2) | null | Alternative | Merge fields and dynamic references. Returned only when the include parameter is used. Maximum items: 50 |
configured_properties (anyOf 2)[] | Model | Each item | Expand Get all states of a kiosk — response body — states states item configured properties null item |
details | Model | Optional | Expand Get all states of a kiosk — response body — states states item details |
from_transition | JSON | Optional | |
from_transition (anyOf 1) | object | Alternative | Entry transition details. Null for start states. Additional keys: not allowed |
from_transition (anyOf 1).id | string | Required within parent | Field: id Maximum length: 255 |
from_transition (anyOf 1).name | string | Required within parent | Field: name Maximum length: 255 |
from_transition (anyOf 2) | null | Alternative | Entry transition details. Null for start states. Additional keys: not allowed |
from_transition (anyOf 2).id | string | Required within parent | Field: id Maximum length: 255 |
from_transition (anyOf 2).name | string | Required within parent | Field: name Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the kiosk state. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk state. Maximum length: 255 |
transitions | JSON | Optional | |
transitions (anyOf 1) | array | Alternative | Represents the list of outgoing transitions from the kiosk state. Maximum items: 25 |
transitions (anyOf 1)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition |
transitions (anyOf 2) | null | Alternative | Represents the list of outgoing transitions from the kiosk state. Maximum items: 25 |
transitions (anyOf 2)[] | Model | Each item | Expand Get a specific kiosk state by ID — response body — states / item / type: action from transition |
type | string | Required within parent | Represents the state type, indicating whether the state is a screen, decision, action, or get_records state. Known values: start_state, screen, get_records, end_state, action, decision Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item, Get a specific kiosk state by ID — response body — states / item / type: action from transition, Get all states of a kiosk — response body — states states item details, Get all states of a kiosk — response body — states states item configured properties null item