Skip to content

Zoho: Kiosks execute schemas

46 Zoho schemas with complete fields and constraints.

← Kiosks execute operations · All schemas

Execute a Kiosk — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for executing a kiosk, containing one or more execute action entries.
Additional keys: not allowed
kiosk_executearrayRequired within parentThe request body must be a JSON object containing the kiosk_execute array. The array contains the data required to execute the Kiosk.
Maximum items: 1
kiosk_execute[]ModelEach itemExpand Execute a Kiosk — request body — body kiosk execute item

Referenced models: Execute a Kiosk — request body — body kiosk execute item

Execute a Kiosk — request body — body kiosk execute item

FieldTypePresenceDescription and constraints
$objectRootRepresents an execute action entry used to process a kiosk state with the provided data context.
Additional keys: not allowed
dataModelOptionalExpand Execute a Kiosk — request body — body kiosk execute item data
Specify the data context for the Kiosk execution. If not provided, the Kiosk will execute without a record context.

Referenced models: Execute a Kiosk — request body — body kiosk execute item data

Execute a Kiosk — request body — body kiosk execute item data

FieldTypePresenceDescription and constraints
$objectRootRepresents the execution data container, holding the current record reference and the execution instance ID.
Additional keys: not allowed
Current_RecordModelOptionalExpand Execute a Kiosk — request body — body kiosk execute item data Current Record
The Current_Record field provides the record context for the Kiosk execution.
idstring or nullOptionalRepresents the unique identifier of the kiosk execution instance.
Maximum length: 18

Referenced models: Execute a Kiosk — request body — body kiosk execute item data Current Record

Execute a Kiosk — request body — body kiosk execute item data Current Record

FieldTypePresenceDescription and constraints
$objectRootRepresents a reference to the current module record used during kiosk execution, including the record ID.
Additional keys: not allowed
idstring or nullOptionalRepresents the unique identifier of the current module record referenced during execution.

Maximum length: 19

Execute a Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootIndicates a successful execute action and provides details about the next executable kiosk state.
Additional keys: not allowed
kiosk_executearrayOptionalContains the result of the execute action, including the status, message, and details of the next executable state.
Maximum items: 1
kiosk_execute[]ModelEach itemExpand Execute a Kiosk — response body — kiosk execute item

Referenced models: Execute a Kiosk — response body — kiosk execute item

Execute a Kiosk — response body — kiosk execute item

FieldTypePresenceDescription and constraints
$objectRootRepresents the result of an execute action, including the status code, message, and details of the next executable state.
Additional keys: not allowed
codestringOptionalRepresents the status code returned for the execute action result.
Maximum length: 255
detailsModelOptionalExpand Execute a Kiosk — response body — kiosk execute item details
messagestringOptionalRepresents the message describing the outcome of the execute action.
Maximum length: 255
statusstringOptionalRepresents the response status indicating whether the execute action succeeded or encountered an error.
Maximum length: 255

Referenced models: Execute a Kiosk — response body — kiosk execute item details

Execute a Kiosk — response body — kiosk execute item details

FieldTypePresenceDescription and constraints
$objectRootProvides details of a test run execution, including the next executable state, any dependent states that were executed, and the execution record ID.
Additional keys: not allowed
executed_dependent_statesJSONOptional
executed_dependent_states (anyOf 1)arrayAlternativeContains the list of dependent states that were executed as part of the test run, or null if no dependent states were triggered.
Maximum items: 10
executed_dependent_states (anyOf 1)[]ModelEach itemExpand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
executed_dependent_states (anyOf 2)nullAlternativeContains the list of dependent states that were executed as part of the test run, or null if no dependent states were triggered.
Maximum items: 10
executed_dependent_states (anyOf 2)[]ModelEach itemExpand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
idstringOptionalContains the unique identifier of the test run execution record.
Maximum length: 255
next_executable_stateModelOptionalExpand Execute a Kiosk — response body — kiosk execute item details next executable state

Referenced models: Execute a Kiosk — response body — kiosk execute item details next executable state, Execute a Kiosk — response body — kiosk execute item details executed dependent states null item

Execute a Kiosk — response body — kiosk execute item details executed dependent states null item

FieldTypePresenceDescription and constraints
$objectRootA dependent state executed during kiosk execution
Additional keys: not allowed
detailsobjectOptionalField: details — optional state-specific details
Additional keys: allowed
idstringRequired within parentField: id
Maximum length: 255
namestringRequired within parentField: name
Maximum length: 255
ridstringOptionalField: rid
Format: uuid
Maximum length: 255
transitionobjectRequired within parentField: transition
Additional keys: not allowed
transition.idstringRequired within parentField: id
Maximum length: 255
transition.namestringRequired within parentField: name
Maximum length: 255
transition.ridstringOptionalField: rid
Format: uuid
Maximum length: 255
typestringOptionalField: type
Maximum length: 255

Execute a Kiosk — response body — kiosk execute item details next executable state

FieldTypePresenceDescription and constraints
$objectRootAn array of dependent states that were executed during the test run. Each object contains information about the state and the transition taken.
Additional keys: not allowed
idstringOptionalContains the unique identifier of the next executable kiosk state.
Maximum length: 255
namestringOptionalRepresents the display name of the next executable kiosk state.
Maximum length: 255

Initiate a Test Run for a Kiosk — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for a kiosk test run, containing one or more test run entries.
Additional keys: not allowed
kiosk_test_runarrayRequired within parentContains one or more test run entries, each providing the data context for initiating a kiosk test run.
Maximum items: 1
kiosk_test_run[]ModelEach itemExpand Initiate a Test Run for a Kiosk — request body — body kiosk test run item

Referenced models: Initiate a Test Run for a Kiosk — request body — body kiosk test run item

Initiate a Test Run for a Kiosk — request body — body kiosk test run item

FieldTypePresenceDescription and constraints
$objectRootRepresents a test run payload entry that provides the data context needed for executing a kiosk test run.
Additional keys: not allowed
dataModelOptionalExpand Execute a Kiosk — request body — body kiosk execute item data
Contains information about the current record module if any

Referenced models: Execute a Kiosk — request body — body kiosk execute item data

Initiate a Test Run for a Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response for a successful kiosk test run, including the status, message, and details of the next executable state.
Additional keys: not allowed
kiosk_test_runarrayOptionalContains the result of the test run, including status, message, and details of the next executable state.
Maximum items: 1
kiosk_test_run[]ModelEach itemExpand Initiate a Test Run for a Kiosk — response body — kiosk test run item

Referenced models: Initiate a Test Run for a Kiosk — response body — kiosk test run item

Initiate a Test Run for a Kiosk — response body — kiosk test run item

FieldTypePresenceDescription and constraints
$objectRootRepresents the outcome of a test run entry, including the status code, message, and detailed execution data.
Additional keys: not allowed
codestringOptionalRepresents the status code returned for the test run entry.
Maximum length: 255
detailsModelOptionalExpand Execute a Kiosk — response body — kiosk execute item details
messagestringOptionalContains the message describing the outcome of the test run entry.
Maximum length: 255
statusstringOptionalIndicates the overall status of the test run entry result.
Maximum length: 255

Referenced models: Execute a Kiosk — response body — kiosk execute item details

List kiosk executions — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents a paginated list of kiosk execution records along with pagination metadata.
Additional keys: not allowed
infoModelRequired within parentExpand List kiosk executions — response body — info
kiosk_executionsarrayRequired within parentContains the list of kiosk execution records returned for the specified kiosk.
Maximum items: 4
kiosk_executions[]ModelEach itemExpand List kiosk executions — response body — kiosk executions item

Referenced models: List kiosk executions — response body — kiosk executions item, List kiosk executions — response body — info

List kiosk executions — response body — info

FieldTypePresenceDescription and constraints
$objectRootRepresents pagination metadata for list responses, including the current page number, records per page, total count, and whether more records are available.
Additional keys: not allowed
countJSONRequired within parent
count (anyOf 1)integerAlternativeIndicates the number of kiosk execution records returned in the current page.
Format: int32
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_recordsbooleanRequired within parentIndicates whether more execution records are available beyond the current page.

Possible values:
true - Additional execution records exist beyond the current page.
false - No additional execution records exist; the current page is the last.
pageJSONRequired within parent
page (anyOf 1)integerAlternativeIndicates the current page number in the paginated list of execution records.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_pageJSONRequired within parent
per_page (anyOf 1)integerAlternativeIndicates the maximum number of kiosk execution records returned per page.
Format: int32
per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List kiosk executions — response body — kiosk executions item

FieldTypePresenceDescription and constraints
$objectRootRepresents an execution instance of a kiosk, including start and end timestamps, owner information, executable state details, and the execution record ID.
Additional keys: not allowed
Kiosk_End_TimestringRequired within parentThe timestamp indicating when the most recently executed state of the Kiosk ended, in ISO 8601 format. The response is sorted in descending order of this field, with the most recent executions listed first.
Maximum length: 255
Kiosk_Start_TimestringRequired within parentRepresents the date and time at which the kiosk execution record session began.
Maximum length: 255
OwnerModelRequired within parentExpand List kiosk executions — response body — kiosk executions item Owner
executable_infoModelRequired within parentExpand List kiosk executions — response body — kiosk executions item executable info
idstringRequired within parentThe unique identifier of the available transition.
Maximum length: 255

Referenced models: List kiosk executions — response body — kiosk executions item executable info, List kiosk executions — response body — kiosk executions item Owner

List kiosk executions — response body — kiosk executions item Owner

FieldTypePresenceDescription and constraints
$objectRootContains information about the owner of the record who initiated this kiosk execution.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the record owner in the preview.
Maximum length: 255
namestringRequired within parentRepresents the full name of the record owner in the preview.
Maximum length: 255

List kiosk executions — response body — kiosk executions item executable info

FieldTypePresenceDescription and constraints
$objectRootContains information about the current state of the Kiosk execution and the transition that can be executed next.
Additional keys: not allowed
stateModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
transitionsarrayRequired within parentAn array of available next transitions from the current state. Each transition object contains the unique identifier of an available transition from the current state.
Maximum items: 1
transitions[]ModelEach itemExpand List kiosk executions — response body — kiosk executions item executable info transitions item

Referenced models: List kiosk executions — response body — kiosk executions item executable info transitions item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state

List kiosk executions — response body — kiosk executions item executable info transitions item

FieldTypePresenceDescription and constraints
$objectRootRepresents a minimal transition reference used in kiosk execution records, containing the transition ID.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the kiosk transition referenced in the execution record.
Maximum length: 255

Retrieve a kiosk execution record — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response for a specific kiosk execution state view, containing the elements and metadata for the state being executed.
Additional keys: not allowed
kiosk_executionsarrayRequired within parentContains the details of the execution state being rendered, including elements, layout, and data.
Maximum items: 1
kiosk_executions[]ModelEach itemExpand Retrieve a kiosk execution record — response body — kiosk executions item

Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item

Retrieve a kiosk execution record — response body — kiosk executions item

FieldTypePresenceDescription and constraints
$objectRootRepresents the screen and data for a specific execution state, including elements, layout dimensions, screen title, kiosk details, and executable information.
Additional keys: not allowed
button_alignJSONRequired within parent
button_align (anyOf 1)stringAlternativeThe alignment of action buttons. 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.
Known values: right_to_left, left_to_right, center
Maximum length: 255
button_align (anyOf 2)nullAlternativeThe alignment of action buttons. 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.
Known values: right_to_left, left_to_right, center
Maximum length: 255
dataModelRequired within parentExpand Retrieve a kiosk execution record — response body — kiosk executions item data
elementsarrayRequired within parentAn array of UI elements and data sources configured in the Kiosk. Each element has a type field that determines its structure.
Maximum items: 1
elements[]ModelEach itemExpand Retrieve a kiosk execution record — response body — kiosk executions item elements item
executable_infoModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info
idstringRequired within parentContains the unique identifier of the kiosk execution view record.
Maximum length: 255
kioskModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk
titlestringRequired within parentRepresents the display title of the kiosk execution state screen.
Maximum length: 255
widthJSONRequired within parent
width (anyOf 1)stringAlternativeIndicates the display width of the kiosk execution state screen.
Known values: 670px, 1000px
Maximum length: 255
width (anyOf 2)nullAlternativeIndicates the display width of the kiosk execution state screen.
Known values: 670px, 1000px
Maximum length: 255

Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item data, Retrieve a kiosk execution record — response body — kiosk executions item elements item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk

Retrieve a kiosk execution record — response body — kiosk executions item data

FieldTypePresenceDescription and constraints
$objectRootContains the runtime data available during the Kiosk execution. This object includes system-generated values (such as execution details, owner information, and record references) along with dynamically generated key-value pairs. The dynamic keys correspond to the API names of the configured Kiosk fields, GetRecords elements, and other runtime values available in the current execution. The fields returned vary depending on the Kiosk configuration and the execution context.
Additional keys: not allowed
Kiosk_End_TimestringRequired within parentRepresents the date and time at which the kiosk execution session ended.
Maximum length: 255
Kiosk_Start_TimestringRequired within parentRepresents the date and time at which the kiosk execution session began.
Maximum length: 255
OwnerModelRequired within parentExpand Retrieve a kiosk execution record — response body — kiosk executions item data Owner
idstringRequired within parentContains the unique identifier for the kiosk execution instance.
Maximum length: 255

Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item data Owner

Retrieve a kiosk execution record — response body — kiosk executions item data Owner

FieldTypePresenceDescription and constraints
$objectRootRepresents detailed owner information for a kiosk execution, including name, ID, and email address.
Additional keys: not allowed
emailstringRequired within parentRepresents the email address of the owner associated with the kiosk execution.
Maximum length: 255
idstringRequired within parentContains the unique identifier of the owner associated with the kiosk execution.
Maximum length: 255
namestringRequired within parentRepresents the full name of the owner associated with the kiosk execution.
Maximum length: 255

Retrieve a kiosk execution record — response body — kiosk executions item elements item

FieldTypePresenceDescription and constraints
$objectRootRepresents a simple element associated with a kiosk execution, including its type classification and associated value.
Additional keys: not allowed
typestringRequired within parentIndicates the type classification of the execution element.
Maximum length: 255
valuestringRequired within parentContains the value associated with the execution element.
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response for a successful kiosk preview, returning the initial executable screen with associated data, transitions, and layout metadata.
Additional keys: not allowed
kiosk_previewarrayRequired within parentContains the preview details for the initial executable screen, including elements, transitions, data, and layout.
Maximum items: 1
kiosk_preview[]ModelEach itemExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item

FieldTypePresenceDescription and constraints
$objectRootRepresents the preview screen for a kiosk state, including executable information, prior states, elements, data, layout width, screen title, and button alignment.
Additional keys: not allowed
button_alignstringRequired within parentThe alignment of action buttons.

**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.

Maximum length: 255
dataModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data
elementsarrayRequired within parentContains the list of elements rendered on the kiosk preview screen.
Maximum items: 2
elements[]JSONEach itemRepresents one element rendered on the kiosk preview screen, such as a record retrieval block or a form field.
elements[] (anyOf 1)ModelAlternativeExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value
elements[] (anyOf 2)ModelAlternativeExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value
executable_infoModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info
kioskModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk
previous_statesarrayRequired within parentSpecifies an array containing the states traversed before the current state in the Kiosk execution flow. The states are listed in the order they were executed, starting from the start state and ending with the state immediately preceding the current state.
Maximum items: 2
previous_states[]ModelEach itemExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item
titlestringRequired within parentRepresents the display title of the kiosk preview screen.
Maximum length: 255
widthstringRequired within parentIndicates the display width of the kiosk preview screen.
Maximum length: 255

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data

FieldTypePresenceDescription and constraints
$objectRootContains the records retrieved by the data elements configured in the Kiosk. This object uses dynamic keys, where each key is the API name of a data element (for example, a Get Records element). Each key maps to an object containing the retrieved record's display name (name) and unique identifier (id).
Additional keys: not allowed
GetRecords_1arrayRequired within parentContains the list of record summaries returned by the GetRecords_1 element in the preview screen.
Maximum items: 1
GetRecords_1[]ModelEach itemExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item

FieldTypePresenceDescription and constraints
$objectRootRepresents a summarized record item returned as part of the preview data set, including the record name and ID.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the record summary item in the preview data.
Maximum length: 255
namestringRequired within parentRepresents the display name of the record summary item in the preview data.
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value

FieldTypePresenceDescription and constraints
$objectRootRepresents a field-based element within the kiosk preview screen, including its type classification and current value.
Additional keys: not allowed
fieldModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field
typestringRequired within parentIndicates the type classification of the field-based element in the preview screen.
Maximum length: 255
valuestringRequired within parentContains the current value of the field-based element in the preview screen.
Maximum length: 255

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field

FieldTypePresenceDescription and constraints
$objectRootDescribes a form or data field in the kiosk preview screen, including its label, API name, data type, UI type, and display constraints.
Additional keys: not allowed
_merge_fieldstringRequired within parentRepresents the merge field template reference used to populate the field value from a linked kiosk process flow.
Maximum length: 255
_pick_list_typeJSONRequired within parent
_pick_list_type (anyOf 1)stringAlternativeIndicates the picklist type configuration for the field, when applicable.
Known values: global_set, local
_pick_list_type (anyOf 2)nullAlternativeIndicates the picklist type configuration for the field, when applicable.
Known values: global_set, local
allow_multiple_uploadnullRequired within parentIndicates whether the field supports multiple file uploads, when applicable.
api_namestringRequired within parentRepresents the API name of the field as defined in the CRM module.
Maximum length: 255
currencynullRequired within parentIndicates the currency configuration for the field, when applicable to currency-type fields.
data_typestringRequired within parentRepresents the data type of the field, such as text, integer, or ownerlookup.
Maximum length: 255
decimal_placenullRequired within parentIndicates the number of decimal places configured for the field, when applicable to numeric fields.
field_labelstringRequired within parentRepresents the display label of the field as shown to the user in the kiosk screen.
Maximum length: 255
idstringRequired within parentContains the unique identifier of the field definition in the kiosk screen.
Maximum length: 255
lengthJSONRequired within parent
length (anyOf 1)integerAlternativeIndicates the maximum character length configured for the field.
Format: int32
length (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_separatorbooleanRequired within parentIndicates whether the field uses a number separator for display.

Possible values:
true - A number separator is applied when displaying the field value.
false - No number separator is applied.
pick_list_valuesnullRequired within parentContains the available picklist values for the field, when applicable to picklist field types.
read_onlybooleanRequired within parentIndicates whether the field is read-only in the kiosk screen.

Possible values:
true - The field is read-only and cannot be edited by the user.
false - The field is editable by the user.
requiredbooleanRequired within parentIndicates whether the field is required in the kiosk screen.

Possible values:
true - The field must be filled in before the user can proceed.
false - The field is optional.
tooltipnullRequired within parentContains the tooltip text displayed for the field, when applicable.
ui_typeJSONRequired within parent
ui_type (anyOf 1)integerAlternativeRepresents the UI type identifier that determines how the field is rendered in the kiosk screen.
Format: int32
ui_type (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value

FieldTypePresenceDescription and constraints
$objectRootRepresents a preview element data block that aggregates record retrieval configuration, raw values, record data, and pagination flags for a get record element.
Additional keys: not allowed
get_recordModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record
get_record_dataarrayRequired within parentContains the list of CRM records returned by the get record element in the preview screen.
Maximum items: 19
get_record_data[]JSONEach itemRepresents a single CRM record entry returned by the get record element, including key field values and owner details.
get_record_data[] (anyOf 1)ModelAlternativeExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id
more_recordsbooleanRequired within parentIndicates whether additional CRM records are available beyond those returned in the current preview response.

Possible values:
true - More records are available and can be retrieved.
false - All available records have been returned in the current response.
typestringRequired within parentIndicates the type classification of the preview element data block.
Maximum length: 255
valuenullRequired within parentContains the value of the preview element data block, which may be null when the block uses a record retrieval configuration.

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record

FieldTypePresenceDescription and constraints
$objectRootRepresents the configuration for a get record element in the preview screen, including selection details, module information, and the list of selected fields.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the get record element as defined in the kiosk configuration.
Maximum length: 255
idstringRequired within parentContains the unique identifier of the get record element in the kiosk configuration.
Maximum length: 255
moduleModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record module
namestringRequired within parentRepresents the display name of the get record element in the kiosk configuration.
Maximum length: 255
open_recordbooleanRequired within parentIndicates whether the record detail view opens when a user selects a record in the preview.

Possible values:
true - The record detail view opens on selection.
false - The record detail view does not open on selection.
selected_fieldsarrayRequired within parentContains the list of CRM fields configured for display in the get record element of the preview screen.
Maximum items: 3
selected_fields[]ModelEach itemExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selected fields item
selection_detailsModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selection details

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record module, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selected fields item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selection details

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id

FieldTypePresenceDescription and constraints
$objectRootRepresents the data returned for a previewed CRM record, including key field values and owner details.
Additional keys: not allowed
CompanystringRequired within parentRepresents the company name of the previewed CRM record.
Maximum length: 255
First_NameJSONRequired within parent
First_Name (anyOf 1)stringAlternativeRepresents the first name of the contact or lead in the previewed CRM record.
Maximum length: 255
First_Name (anyOf 2)nullAlternativeRepresents the first name of the contact or lead in the previewed CRM record.
Maximum length: 255
OwnerModelRequired within parentExpand List kiosk executions — response body — kiosk executions item Owner
idstringRequired within parentContains the unique identifier of the previewed CRM record.
Maximum length: 255

Referenced models: List kiosk executions — response body — kiosk executions item Owner

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record module

FieldTypePresenceDescription and constraints
$objectRootDescribes the CRM module used in the preview get record element, including its display label, API name, internal name, and ID.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the CRM module used in the preview get record element.
Maximum length: 255
display_labelstringRequired within parentRepresents the display label of the CRM module shown to the user in the preview.
Maximum length: 255
idstringRequired within parentContains the unique identifier of the CRM module used in the preview get record element.
Maximum length: 255
namestringRequired within parentRepresents the internal name of the CRM module used in the preview get record element.
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selected fields item

FieldTypePresenceDescription and constraints
$objectRootRepresents metadata for a field included in the preview selection, including the field label, API name, UI type, and data type.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the selected field included in the preview screen.
Maximum length: 255
data_typestringRequired within parentRepresents the data type of the selected field, such as text or ownerlookup.
Maximum length: 255
field_labelstringRequired within parentRepresents the display label of the selected field as shown in the preview screen.
Maximum length: 255
idstringRequired within parentContains the unique identifier of the selected field definition in the preview screen.
Maximum length: 255
ui_typeJSONRequired within parent
ui_type (anyOf 1)integerAlternativeRepresents the UI type identifier that determines how the selected field is rendered in the preview.
Format: int32
ui_type (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record selection details

FieldTypePresenceDescription and constraints
$objectRootDefines the record selection behavior for a get record element in the preview, including the selection type, result type, and record limit.
Additional keys: not allowed
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeIndicates the maximum number of records to retrieve in the get record element of the preview.
Format: int32
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_typestringRequired within parentIndicates the type of result set returned by the get record element, such as all records.
Known values: single, multiple, all
Maximum length: 255
selection_typestringRequired within parentIndicates the selection behavior applied to the records returned by the get record element.
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info

FieldTypePresenceDescription and constraints
$objectRootProvides the current state and available transitions for the executable context of a kiosk preview.
Additional keys: not allowed
stateModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
transitionsarrayRequired within parentSpecifies the list of transitions available from the current state. Each transition contains the display name, unique ID, prop_name,is_connected_end.
Maximum items: 1
transitions[]ModelEach itemExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item

Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state

FieldTypePresenceDescription and constraints
$objectRootRepresents a summary of a kiosk state referenced in the preview, including the state ID and display name.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the kiosk state referenced in the preview.
Maximum length: 255
namestringRequired within parentRepresents the display name of the kiosk state referenced in the preview.
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item

FieldTypePresenceDescription and constraints
$objectRootDescribes a transition in the kiosk preview, including the connection flag, display name, ID, and property name of the transition button.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the transition in the kiosk preview.
Maximum length: 255
is_connected_endbooleanRequired within parentIndicates whether this transition leads to a connected end state in the kiosk flow.

Possible values:
true - The transition leads to a connected end state.
false - The transition leads to an intermediate state in the kiosk flow.
namestringRequired within parentRepresents the display name of the transition in the kiosk preview.
Maximum length: 255
prop_namestringRequired within parentSpecifies the type of button displayed on the Kiosk screen. Each button corresponds to a transition path that the user can select from the current screen.
**Possible values:**

**primary** - Displays the button as the primary action on the screen, typically used for actions such as Next, Submit, or Save.

**default** - Displays the button with the standard appearance, suitable for secondary actions.

**outlineprimary** - Displays the button with a primary-colored outline, emphasizing the action without making it the primary button.

**failure** - Displays the button with a solid error-themed style, typically used for destructive or critical actions such as Delete or Reject.

**outlineredlight** - Displays the button with a red outline, typically used for secondary destructive actions such as Cancel, Discard, or Remove.

Known values: primary, default, outlineprimary, failure, outlineredlight
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk

FieldTypePresenceDescription and constraints
$objectRootRepresents a minimal summary of the kiosk in the preview, including the kiosk name and ID.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the kiosk associated with the preview.
Maximum length: 255
namestringRequired within parentRepresents the display name of the kiosk associated with the preview.
Maximum length: 255

Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item

FieldTypePresenceDescription and constraints
$objectRootRepresents a summary of a previously executed kiosk state available in the preview, including the state name, ID, and type.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the previously executed kiosk state.
Maximum length: 255
namestringRequired within parentRepresents the display name of the previously executed kiosk state.
Maximum length: 255
typestringRequired within parentIndicates the type classification of the previously executed kiosk state, such as start_state or get_records.
Maximum length: 255

Update a Kiosk Execution — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for advancing a kiosk execution state, containing one or more execution action entries.
Additional keys: not allowed
kiosk_executionsarrayRequired within parentContains one or more execution action entries, each specifying the transition and data context for advancing the kiosk execution to the next state.
Maximum items: 1
kiosk_executions[]ModelEach itemExpand Update a Kiosk Execution — request body — body kiosk executions item

Referenced models: Update a Kiosk Execution — request body — body kiosk executions item

Update a Kiosk Execution — request body — body kiosk executions item

FieldTypePresenceDescription and constraints
$objectRootRepresents an action entry for progressing a kiosk execution, providing the data context and transition information.
Additional keys: not allowed
dataModelOptionalExpand Execute a Kiosk — request body — body kiosk execute item data
Contains information about the current execution
transitionModelRequired within parentExpand Update a Kiosk Execution — request body — body kiosk executions item transition
Contains the transition information for next execution (Required)

Referenced models: Execute a Kiosk — request body — body kiosk execute item data, Update a Kiosk Execution — request body — body kiosk executions item transition

Update a Kiosk Execution — request body — body kiosk executions item transition

FieldTypePresenceDescription and constraints
$objectRootRepresents transition input providing the transition name and required ID for kiosk execution progression.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the transition that triggers the current execution step.
Maximum length: 19
namestring or nullOptionalRepresents the display name of the transition that triggers the current execution step.
Maximum length: 50

Update a Kiosk Execution — response body

FieldTypePresenceDescription and constraints
$objectRootIndicates that an execution action completed successfully and provides details of the next executable state and execution ID.
Additional keys: not allowed
kiosk_executionsarrayOptionalContains the result of the execution action, including the status, message, and details of the next executable state.
Maximum items: 1
kiosk_executions[]ModelEach itemExpand Update a Kiosk Execution — response body — kiosk executions item

Referenced models: Update a Kiosk Execution — response body — kiosk executions item

Update a Kiosk Execution — response body — kiosk executions item

FieldTypePresenceDescription and constraints
$objectRootRepresents the result of an execution action, including the status code, message, and details of the next executable state.
Additional keys: not allowed
codestringOptionalRepresents the status code returned for the execution action result.
Maximum length: 255
detailsModelOptionalExpand Execute a Kiosk — response body — kiosk execute item details
messagestringOptionalContains the message describing the outcome of the execution action.
Maximum length: 255
statusstringOptionalIndicates the overall status of the execution action result.
Maximum length: 255

Referenced models: Execute a Kiosk — response body — kiosk execute item details

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.