Skip to content

Zoho: Kiosks schemas

37 Zoho schemas with complete fields and constraints.

← Kiosks operations · All schemas

Activate Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned when a kiosk has been successfully activated, including the operation status.
Additional keys: not allowed
kiosksModelOptionalExpand Activate Kiosk — response body — kiosks

Referenced models: Activate Kiosk — response body — kiosks

Activate Kiosk — response body — kiosks

FieldTypePresenceDescription and constraints
$objectRootRepresents the status of a kiosk activation operation, including the status code, message, and details of the activated kiosk.
Additional keys: not allowed
codestringOptionalRepresents the status code returned for the kiosk activation operation.
Maximum length: 255
detailsModelOptionalExpand Activate Kiosk — response body — kiosks details
messagestringOptionalRepresents the error message describing the issue.
Maximum length: 255
statusstringOptionalIndicates the outcome status of the kiosk activation operation.
Maximum length: 255

Referenced models: Activate Kiosk — response body — kiosks details

Activate Kiosk — response body — kiosks details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier of the activated kiosk returned in an activation operation response.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the kiosk activation item detail.
Maximum length: 255

Clone a Kiosk — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for cloning a kiosk, containing the list of kiosk configurations to be created via cloning.
Additional keys: not allowed
kiosksarrayRequired within parentContains the details for the kiosk to be cloned.
Maximum items: 1
kiosks[]ModelEach itemExpand Clone a Kiosk — request body — body kiosks item

Referenced models: Clone a Kiosk — request body — body kiosks item

Clone a Kiosk — request body — body kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the attributes for creating a new kiosk from an existing one, including name, description, clone type (dependent or standalone), and group API name.
Additional keys: not allowed
descriptionstring or nullOptionalSpecifies the description of the kiosk.
Maximum length: 500
group_api_namestring or nullOptionalSpecifies the unique group API name for the kiosk.
Maximum length: 25
namestring or nullOptionalSpecifies the name of the kiosk.
Maximum length: 50
Pattern: [0-9a-zA-Z_\\-\\.\\|\\$\\?\\,\\'\\/\\!\\P{InBasicLatin}\\s]+
typestringRequired within parentSpecifies the type of the cloned kiosk. Possible values:
dependent - The cloned kiosk depends on the source kiosk.
standalone - The cloned kiosk operates independently of the source kiosk.
One of: dependent, standalone
Maximum length: 20

Clone a Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned when a kiosk clone operation completes successfully, including the status information for the cloned kiosk.
Additional keys: not allowed
kiosksModelOptionalExpand Clone a Kiosk — response body — kiosks

Referenced models: Clone a Kiosk — response body — kiosks

Clone a Kiosk — response body — kiosks

FieldTypePresenceDescription and constraints
$objectRootRepresents the status of a kiosk clone operation, including the status code, message, and item details.
Additional keys: not allowed
codestringOptionalRepresents the status code of the kiosk clone operation.
Maximum length: 255
detailsModelOptionalExpand Clone a Kiosk — response body — kiosks details
messagestringOptionalRepresents the message describing the outcome of the kiosk clone operation.
Maximum length: 255
statusstringOptionalIndicates the result status of the kiosk clone operation.
Maximum length: 255

Referenced models: Clone a Kiosk — response body — kiosks details

Clone a Kiosk — response body — kiosks details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifiers and related details for a cloned kiosk item returned in a clone operation response.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the kiosk.
Maximum length: 255

Create a Kiosk — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the top-level request payload for creating a kiosk. Contains a kiosks array, with one kiosk object per request.
Additional keys: not allowed
kiosksarrayRequired within parentContains the details of the kiosk to be created. Although the field is an array, only one kiosk can be created per request.
Maximum items: 1
kiosks[]ModelEach itemExpand Create a Kiosk — request body — body kiosks item

Referenced models: Create a Kiosk — request body — body kiosks item

Create a Kiosk — request body — body kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the attributes required to create a kiosk, including name, optional description, unique group API name, status, and optional current record module.
Additional keys: not allowed
current_record_moduleModelOptionalExpand Create a Kiosk — request body — body kiosks item current record module
It is a json object which will contain the details of the current record module being set for the Kiosk. Current record is a designated module from which a specific record will be used for actions inside the Kiosk. For example, if the current record is set as Leads. While running actions or associating a field with current record, the user may have to provide a Lead id during execution. The action/association will be done based on this particular Lead.
descriptionstring or nullOptionalSpecifies the description for the kiosk. The description can indicate the purpose of the kiosk and can be left empty during creation.
Maximum length: 500
group_api_namestring or nullOptionalSpecifies the unique group API name for the kiosk. The group API name should be similar to the kiosk name. Special characters are not allowed.
Maximum length: 25
namestringRequired within parentSpecifies the name of the kiosk. The kiosk name can be at most 25 characters in length.
Maximum length: 25
statusstringRequired within parentSpecifies the status of the kiosk. Upon successful creation, the initial status of the kiosk is always draft. Possible values:
draft - The kiosk is in draft state upon creation.
Maximum length: 5

Referenced models: Create a Kiosk — request body — body kiosks item current record module

Create a Kiosk — request body — body kiosks item current record module

FieldTypePresenceDescription and constraints
$objectRootRepresents the input schema for specifying the current record module when creating a kiosk. When both identifier and api_name are provided, they must reference the same module.
Additional keys: not allowed
api_namestring or nullOptionalSpecifies the API name of the module to set as the current record. When both identifier and api_name are provided, they must point to the same module.
Maximum length: 250
idstring or nullOptionalSpecifies the unique identifier of the module to set as the current record. For example, provide the module ID for Leads.
Maximum length: 19

Create a Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after creating a kiosk, containing an array of per-item operation results.
Additional keys: not allowed
kiosksarrayOptionalContains the list of kiosk objects created.
Maximum items: 1
kiosks[]ModelEach itemExpand Create a Kiosk — response body — kiosks item

Referenced models: Create a Kiosk — response body — kiosks item

Create a Kiosk — response body — kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the per-item result of a kiosk create operation, including the status code, message, status, and identifier of the newly created kiosk.
Additional keys: not allowed
codestringOptionalRepresents the result code of the kiosk create operation.
Maximum length: 255
detailsModelOptionalExpand Create a Kiosk — response body — kiosks item details
messagestringOptionalRepresents the message describing the outcome of the kiosk create operation.
Maximum length: 255
statusstringOptionalIndicates the result status of the kiosk create operation.
Maximum length: 255

Referenced models: Create a Kiosk — response body — kiosks item details

Create a Kiosk — response body — kiosks item details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifiers for the created kiosk, such as the kiosk identifier, returned as part of the operation result.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the newly created kiosk.
Maximum length: 255

Deactivate a Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned when a kiosk has been successfully deactivated, including the operation status.
Additional keys: not allowed
kiosksModelOptionalExpand Deactivate a Kiosk — response body — kiosks

Referenced models: Deactivate a Kiosk — response body — kiosks

Deactivate a Kiosk — response body — kiosks

FieldTypePresenceDescription and constraints
$objectRootRepresents the status of a kiosk deactivation operation, including the status code, message, and details of the deactivated kiosk.
Additional keys: not allowed
codestringOptionalRepresents the status code returned for the kiosk deactivation operation.
Maximum length: 255
detailsModelOptionalExpand Deactivate a Kiosk — response body — kiosks details
messagestringOptionalRepresents the message describing the outcome of the kiosk deactivation operation.
Maximum length: 255
statusstringOptionalIndicates the result status of the kiosk deactivation operation.
Maximum length: 255

Referenced models: Deactivate a Kiosk — response body — kiosks details

Deactivate a Kiosk — response body — kiosks details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier of the deactivated kiosk returned in a deactivation operation response.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the kiosk deactivation item detail.
Maximum length: 255

Delete a kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after deleting a single kiosk, containing one per-item operation result.
Additional keys: not allowed
kiosksarrayOptionalContains the list of kiosk result objects from the delete operation.
Maximum items: 1
kiosks[]ModelEach itemExpand Delete a kiosk — response body — kiosks item

Referenced models: Delete a kiosk — response body — kiosks item

Delete a kiosk — response body — kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the per-item result of a single kiosk delete operation, including the status code, message, status, and identifier of the deleted kiosk.
Additional keys: not allowed
codestringOptionalRepresents the result code of the kiosk delete operation.
Maximum length: 255
detailsModelOptionalExpand Delete a kiosk — response body — kiosks item details
messagestringOptionalRepresents the message describing the outcome of the kiosk delete operation.
Maximum length: 255
statusstringOptionalIndicates the result status of the kiosk delete operation.
Maximum length: 255

Referenced models: Delete a kiosk — response body — kiosks item details

Delete a kiosk — response body — kiosks item details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier of the kiosk deleted in a single delete operation.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the deleted kiosk.
Maximum length: 255

Get All Kiosks — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response payload delivering detailed information for a specific kiosk, including workflow and configuration data.
Additional keys: not allowed
kiosksarrayRequired within parentContains the list of kiosk objects with detailed information.
Maximum items: 50
kiosks[]ModelEach itemExpand Get All Kiosks — response body — kiosks item

Referenced models: Get All Kiosks — response body — kiosks item

Get All Kiosks — response body — kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents a compact summary of a kiosk with core attributes, module references, current record module, status, ownership, and version details.
Additional keys: allowed
associatedbooleanRequired within parentIndicates whether the kiosk is associated with other CRM components. Possible values:
true - The kiosk is associated with other components.
false - The kiosk is not associated with other components.
chart_dataobjectOptionalContains the workflow visualization data for the kiosk, including chart-specific configuration.
Additional keys: allowed
created_byModelRequired within parentExpand Get All Kiosks — response body — kiosks item created by
created_timestringRequired within parentRepresents the creation timestamp of the kiosk.
Maximum length: 255
current_record_moduleJSONRequired within parentRepresents the module configured as the current record for the kiosk.
current_record_module (anyOf 1)ModelAlternativeExpand Get All Kiosks — response body — kiosks item current record module value
current_record_module (anyOf 2)nullAlternativeRepresents the null state when no current record module is configured for the kiosk.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeRepresents the description of the kiosk. This value may be null if no description is provided.
Maximum length: 255
description (anyOf 2)nullAlternativeRepresents the description of the kiosk. This value may be null if no description is provided.
Maximum length: 255
group_api_namestringRequired within parentRepresents the unique group API name for the kiosk.
Maximum length: 255
group_idstringRequired within parentRepresents the unique identifier of the group to which the kiosk belongs.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the kiosk.
Maximum length: 255
modified_byModelRequired within parentExpand Get All Kiosks — response body — kiosks item modified by
modified_timestringRequired within parentRepresents the date and time when the kiosk was last modified.
Maximum length: 255
moduleModelRequired within parentExpand Get All Kiosks — response body — kiosks item module
namestringRequired within parentRepresents the name of the kiosk.
Maximum length: 255
sequence_numberJSONRequired within parent
sequence_number (anyOf 1)integerAlternativeRepresents the display order of the kiosk within its group.
Format: int32
sequence_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statesarrayOptionalContains the list of workflow states defined for the kiosk.
Maximum items: 100
states[]objectEach itemRepresents a workflow state of the kiosk, including its name, identifier, and type.
Additional keys: allowed
statusstringRequired within parentRepresents the current status of the kiosk.
Maximum length: 255
transitionsarrayOptionalContains the list of workflow transitions defined for the kiosk.
Maximum items: 100
transitions[]objectEach itemRepresents a workflow transition of the kiosk, including its name and identifier.
Additional keys: allowed
version_detailsModelRequired within parentExpand Get All Kiosks — response body — kiosks item version details

Referenced models: Get All Kiosks — response body — kiosks item created by, Get All Kiosks — response body — kiosks item modified by, Get All Kiosks — response body — kiosks item module, Get All Kiosks — response body — kiosks item current record module value, Get All Kiosks — response body — kiosks item version details

Get All Kiosks — response body — kiosks item created by

FieldTypePresenceDescription and constraints
$objectRootRepresents the summary of the user who created the kiosk, including the user ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who created the kiosk.
Maximum length: 255
namestringRequired within parentRepresents the name of the user who created the kiosk.
Maximum length: 255

Get All Kiosks — response body — kiosks item current record module value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeRepresents a summary of the module assigned as the current record for the kiosk, including the plural label, API name, and identifier.
Additional keys: not allowed
$ (anyOf 1).api_namestringRequired within parentRepresents the API name of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 1).idstringRequired within parentRepresents the unique identifier of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 1).plural_labelstringRequired within parentRepresents the plural display label of the current record module.
Maximum length: 255
$ (anyOf 2)nullAlternativeRepresents a summary of the module assigned as the current record for the kiosk, including the plural label, API name, and identifier.
Additional keys: not allowed
$ (anyOf 2).api_namestringRequired within parentRepresents the API name of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 2).idstringRequired within parentRepresents the unique identifier of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 2).plural_labelstringRequired within parentRepresents the plural display label of the current record module.
Maximum length: 255

Get All Kiosks — response body — kiosks item modified by

FieldTypePresenceDescription and constraints
$objectRootRepresents the summary of the user who last modified the kiosk, including the user ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who last modified the kiosk.
Maximum length: 255
namestringRequired within parentRepresents the name of the user who last modified the kiosk.
Maximum length: 255

Get All Kiosks — response body — kiosks item module

FieldTypePresenceDescription and constraints
$objectRootRepresents the reference to the CRM module configured for the kiosk, including the API name and identifier.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the module configured for the kiosk.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the module configured for the kiosk.
Maximum length: 255

Get All Kiosks — response body — kiosks item version details

FieldTypePresenceDescription and constraints
$objectRootRepresents the versioning metadata for a kiosk, including the parent version identifier and the version number.
Additional keys: not allowed
parent_idnullRequired within parentRepresents the identifier of the parent kiosk version. This value is null for the initial version.
version_numberJSONRequired within parent
version_number (anyOf 1)integerAlternativeRepresents the version number of the kiosk.
Format: int32
version_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get a Specific Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response payload for retrieving a specific kiosk by its identifier, including full workflow and configuration details.
Additional keys: not allowed
kiosksarrayRequired within parentContains the kiosk object retrieved by the specified identifier.
Maximum items: 1
kiosks[]ModelEach itemExpand Get All Kiosks — response body — kiosks item

Referenced models: Get All Kiosks — response body — kiosks item

Kiosk Deletion — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after a bulk kiosk deletion. Contains an array of per-item operation results.
Additional keys: not allowed
kiosksarrayOptionalContains the list of kiosk result objects.
Maximum items: 50
kiosks[]ModelEach itemExpand Kiosk Deletion — response body — kiosks item

Referenced models: Kiosk Deletion — response body — kiosks item

Kiosk Deletion — response body — kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the per-item result of a bulk kiosk delete operation, including the status code, message, status, and identifier of each deleted kiosk.
Additional keys: not allowed
codestringOptionalRepresents the result code indicating the outcome of the bulk delete action for the kiosk.
Maximum length: 255
detailsModelOptionalExpand Kiosk Deletion — response body — kiosks item details
messagestringOptionalRepresents the message describing the outcome of the bulk delete action for the kiosk.
Maximum length: 255
statusstringOptionalRepresents the result status of the bulk delete action for the kiosk.
Maximum length: 255

Referenced models: Kiosk Deletion — response body — kiosks item details

Kiosk Deletion — response body — kiosks item details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier of each kiosk deleted in a bulk delete operation.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the kiosk.
Maximum length: 255

Update a Kiosk — request body — body

FieldTypePresenceDescription and constraints
$objectRootRepresents the alternate top-level request payload for updating a kiosk, containing a kiosks array with one object.
Additional keys: not allowed
kiosksarrayRequired within parentContains the details of the kiosk to be updated. Although the field is an array, only one kiosk can be updated per request.
Maximum items: 1
kiosks[]ModelEach itemExpand Update a Kiosk — request body — body kiosks item

Referenced models: Update a Kiosk — request body — body kiosks item

Update a Kiosk — request body — body kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the alternate schema for updating a kiosk, supporting name, description, read-only identifier, and current record module.
Additional keys: not allowed
current_record_moduleModelOptionalExpand Update a Kiosk — request body — body kiosks item current record module
It is a json object which will contain the details of the current record module being set for the Kiosk. Current record is a designated module from which a specific record will be used for actions inside the Kiosk. For example, if the current record is set as Leads. While running actions or associating a field with current record, the user may have to provide a Lead id during execution. The action/association will be done based on this particular Lead. Current record can be set either in POST or PUT call of kiosks.
descriptionstring or nullOptionalSpecifies the description of the kiosk. The description can indicate the purpose of the kiosk and can be left empty during an update.
Maximum length: 500
group_api_namestring or nullOptionalSpecifies the API name of the kiosk group. The group API name can be at most 25 characters in length.
Maximum length: 25
idstring or nullOptionalSpecifies the unique identifier of the kiosk to be updated. This field is read-only; any changes to this value are not applied.
Maximum length: 19
Read only: true
namestring or nullOptionalSpecifies the name of the kiosk. The kiosk name can be at most 25 characters in length.
Maximum length: 25

Referenced models: Update a Kiosk — request body — body kiosks item current record module

Update a Kiosk — request body — body kiosks item current record module

FieldTypePresenceDescription and constraints
$objectRootRepresents the alternate input schema for specifying the current record module when updating a kiosk. When both identifier and api_name are provided, they must reference the same module.
Additional keys: not allowed
api_namestring or nullOptionalSpecifies the API name of the module to set as the current record. When both identifier and api_name are provided, they must point to the same module.
Maximum length: 250
idstring or nullOptionalSpecifies the unique identifier of the module to set as the current record. Each module has a unique identifier in Zoho CRM.
Maximum length: 18

Update a Kiosk — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after updating a kiosk, containing an array of per-item operation results.
Additional keys: not allowed
kiosksarrayOptionalContains the list of kiosk result objects from the update operation.
Maximum items: 1
kiosks[]ModelEach itemExpand Update a Kiosk — response body — kiosks item

Referenced models: Update a Kiosk — response body — kiosks item

Update a Kiosk — response body — kiosks item

FieldTypePresenceDescription and constraints
$objectRootRepresents the per-item result of a kiosk update operation, including the status code, message, status, and identifier of the updated kiosk.
Additional keys: not allowed
codestringOptionalRepresents the result code of the kiosk update operation.
Maximum length: 255
detailsModelOptionalExpand Update a Kiosk — response body — kiosks item details
messagestringOptionalRepresents the message describing the outcome of the kiosk update operation.
Maximum length: 255
statusstringOptionalIndicates the result status of the kiosk update operation.
Maximum length: 255

Referenced models: Update a Kiosk — response body — kiosks item details

Update a Kiosk — response body — kiosks item details

FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier of the updated kiosk returned as part of the update operation result.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the updated kiosk.
Maximum length: 255

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.