Zoho: Kiosks schemas
37 Zoho schemas with complete fields and constraints.
← Kiosks operations · All schemas
Activate Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when a kiosk has been successfully activated, including the operation status. Additional keys: not allowed |
kiosks | Model | Optional | Expand Activate Kiosk — response body — kiosks |
Referenced models: Activate Kiosk — response body — kiosks
Activate Kiosk — response body — kiosks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the status of a kiosk activation operation, including the status code, message, and details of the activated kiosk. Additional keys: not allowed |
code | string | Optional | Represents the status code returned for the kiosk activation operation. Maximum length: 255 |
details | Model | Optional | Expand Activate Kiosk — response body — kiosks details |
message | string | Optional | Represents the error message describing the issue. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier of the activated kiosk returned in an activation operation response. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk activation item detail. Maximum length: 255 |
Clone a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for cloning a kiosk, containing the list of kiosk configurations to be created via cloning. Additional keys: not allowed |
kiosks | array | Required within parent | Contains the details for the kiosk to be cloned. Maximum items: 1 |
kiosks[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
description | string or null | Optional | Specifies the description of the kiosk. Maximum length: 500 |
group_api_name | string or null | Optional | Specifies the unique group API name for the kiosk. Maximum length: 25 |
name | string or null | Optional | Specifies the name of the kiosk. Maximum length: 50 Pattern: [0-9a-zA-Z_\\-\\.\\|\\$\\?\\,\\'\\/\\!\\P{InBasicLatin}\\s]+ |
type | string | Required within parent | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when a kiosk clone operation completes successfully, including the status information for the cloned kiosk. Additional keys: not allowed |
kiosks | Model | Optional | Expand Clone a Kiosk — response body — kiosks |
Referenced models: Clone a Kiosk — response body — kiosks
Clone a Kiosk — response body — kiosks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the status of a kiosk clone operation, including the status code, message, and item details. Additional keys: not allowed |
code | string | Optional | Represents the status code of the kiosk clone operation. Maximum length: 255 |
details | Model | Optional | Expand Clone a Kiosk — response body — kiosks details |
message | string | Optional | Represents the message describing the outcome of the kiosk clone operation. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifiers and related details for a cloned kiosk item returned in a clone operation response. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk. Maximum length: 255 |
Create a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the top-level request payload for creating a kiosk. Contains a kiosks array, with one kiosk object per request. Additional keys: not allowed |
kiosks | array | Required within parent | Contains 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_module | Model | Optional | Expand 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. |
description | string or null | Optional | Specifies 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_name | string or null | Optional | Specifies 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 |
name | string | Required within parent | Specifies the name of the kiosk. The kiosk name can be at most 25 characters in length. Maximum length: 25 |
status | string | Required within parent | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_name | string or null | Optional | Specifies 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 |
id | string or null | Optional | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after creating a kiosk, containing an array of per-item operation results. Additional keys: not allowed |
kiosks | array | Optional | Contains the list of kiosk objects created. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Create a Kiosk — response body — kiosks item |
Referenced models: Create a Kiosk — response body — kiosks item
Create a Kiosk — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
code | string | Optional | Represents the result code of the kiosk create operation. Maximum length: 255 |
details | Model | Optional | Expand Create a Kiosk — response body — kiosks item details |
message | string | Optional | Represents the message describing the outcome of the kiosk create operation. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifiers for the created kiosk, such as the kiosk identifier, returned as part of the operation result. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the newly created kiosk. Maximum length: 255 |
Deactivate a Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when a kiosk has been successfully deactivated, including the operation status. Additional keys: not allowed |
kiosks | Model | Optional | Expand Deactivate a Kiosk — response body — kiosks |
Referenced models: Deactivate a Kiosk — response body — kiosks
Deactivate a Kiosk — response body — kiosks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the status of a kiosk deactivation operation, including the status code, message, and details of the deactivated kiosk. Additional keys: not allowed |
code | string | Optional | Represents the status code returned for the kiosk deactivation operation. Maximum length: 255 |
details | Model | Optional | Expand Deactivate a Kiosk — response body — kiosks details |
message | string | Optional | Represents the message describing the outcome of the kiosk deactivation operation. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier of the deactivated kiosk returned in a deactivation operation response. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk deactivation item detail. Maximum length: 255 |
Delete a kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after deleting a single kiosk, containing one per-item operation result. Additional keys: not allowed |
kiosks | array | Optional | Contains the list of kiosk result objects from the delete operation. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Delete a kiosk — response body — kiosks item |
Referenced models: Delete a kiosk — response body — kiosks item
Delete a kiosk — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
code | string | Optional | Represents the result code of the kiosk delete operation. Maximum length: 255 |
details | Model | Optional | Expand Delete a kiosk — response body — kiosks item details |
message | string | Optional | Represents the message describing the outcome of the kiosk delete operation. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier of the kiosk deleted in a single delete operation. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the deleted kiosk. Maximum length: 255 |
Get All Kiosks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response payload delivering detailed information for a specific kiosk, including workflow and configuration data. Additional keys: not allowed |
kiosks | array | Required within parent | Contains the list of kiosk objects with detailed information. Maximum items: 50 |
kiosks[] | Model | Each item | Expand Get All Kiosks — response body — kiosks item |
Referenced models: Get All Kiosks — response body — kiosks item
Get All Kiosks — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a compact summary of a kiosk with core attributes, module references, current record module, status, ownership, and version details. Additional keys: allowed |
associated | boolean | Required within parent | Indicates 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_data | object | Optional | Contains the workflow visualization data for the kiosk, including chart-specific configuration. Additional keys: allowed |
created_by | Model | Required within parent | Expand Get All Kiosks — response body — kiosks item created by |
created_time | string | Required within parent | Represents the creation timestamp of the kiosk. Maximum length: 255 |
current_record_module | JSON | Required within parent | Represents the module configured as the current record for the kiosk. |
current_record_module (anyOf 1) | Model | Alternative | Expand Get All Kiosks — response body — kiosks item current record module value |
current_record_module (anyOf 2) | null | Alternative | Represents the null state when no current record module is configured for the kiosk. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Represents the description of the kiosk. This value may be null if no description is provided. Maximum length: 255 |
description (anyOf 2) | null | Alternative | Represents the description of the kiosk. This value may be null if no description is provided. Maximum length: 255 |
group_api_name | string | Required within parent | Represents the unique group API name for the kiosk. Maximum length: 255 |
group_id | string | Required within parent | Represents the unique identifier of the group to which the kiosk belongs. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the kiosk. Maximum length: 255 |
modified_by | Model | Required within parent | Expand Get All Kiosks — response body — kiosks item modified by |
modified_time | string | Required within parent | Represents the date and time when the kiosk was last modified. Maximum length: 255 |
module | Model | Required within parent | Expand Get All Kiosks — response body — kiosks item module |
name | string | Required within parent | Represents the name of the kiosk. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Represents the display order of the kiosk within its group. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
states | array | Optional | Contains the list of workflow states defined for the kiosk. Maximum items: 100 |
states[] | object | Each item | Represents a workflow state of the kiosk, including its name, identifier, and type. Additional keys: allowed |
status | string | Required within parent | Represents the current status of the kiosk. Maximum length: 255 |
transitions | array | Optional | Contains the list of workflow transitions defined for the kiosk. Maximum items: 100 |
transitions[] | object | Each item | Represents a workflow transition of the kiosk, including its name and identifier. Additional keys: allowed |
version_details | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary of the user who created the kiosk, including the user ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the user who created the kiosk. Maximum length: 255 |
name | string | Required within parent | Represents the name of the user who created the kiosk. Maximum length: 255 |
Get All Kiosks — response body — kiosks item current record module value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents 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_name | string | Required within parent | Represents the API name of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 1).id | string | Required within parent | Represents the unique identifier of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 1).plural_label | string | Required within parent | Represents the plural display label of the current record module. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents 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_name | string | Required within parent | Represents the API name of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 2).id | string | Required within parent | Represents the unique identifier of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 2).plural_label | string | Required within parent | Represents the plural display label of the current record module. Maximum length: 255 |
Get All Kiosks — response body — kiosks item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary of the user who last modified the kiosk, including the user ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the user who last modified the kiosk. Maximum length: 255 |
name | string | Required within parent | Represents the name of the user who last modified the kiosk. Maximum length: 255 |
Get All Kiosks — response body — kiosks item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the reference to the CRM module configured for the kiosk, including the API name and identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the module configured for the kiosk. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the module configured for the kiosk. Maximum length: 255 |
Get All Kiosks — response body — kiosks item version details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the versioning metadata for a kiosk, including the parent version identifier and the version number. Additional keys: not allowed |
parent_id | null | Required within parent | Represents the identifier of the parent kiosk version. This value is null for the initial version. |
version_number | JSON | Required within parent | |
version_number (anyOf 1) | integer | Alternative | Represents the version number of the kiosk. Format: int32 |
version_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a Specific Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response payload for retrieving a specific kiosk by its identifier, including full workflow and configuration details. Additional keys: not allowed |
kiosks | array | Required within parent | Contains the kiosk object retrieved by the specified identifier. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Get All Kiosks — response body — kiosks item |
Referenced models: Get All Kiosks — response body — kiosks item
Kiosk Deletion — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after a bulk kiosk deletion. Contains an array of per-item operation results. Additional keys: not allowed |
kiosks | array | Optional | Contains the list of kiosk result objects. Maximum items: 50 |
kiosks[] | Model | Each item | Expand Kiosk Deletion — response body — kiosks item |
Referenced models: Kiosk Deletion — response body — kiosks item
Kiosk Deletion — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
code | string | Optional | Represents the result code indicating the outcome of the bulk delete action for the kiosk. Maximum length: 255 |
details | Model | Optional | Expand Kiosk Deletion — response body — kiosks item details |
message | string | Optional | Represents the message describing the outcome of the bulk delete action for the kiosk. Maximum length: 255 |
status | string | Optional | Represents 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier of each kiosk deleted in a bulk delete operation. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk. Maximum length: 255 |
Update a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the alternate top-level request payload for updating a kiosk, containing a kiosks array with one object. Additional keys: not allowed |
kiosks | array | Required within parent | Contains 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[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the alternate schema for updating a kiosk, supporting name, description, read-only identifier, and current record module. Additional keys: not allowed |
current_record_module | Model | Optional | Expand 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. |
description | string or null | Optional | Specifies 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_name | string or null | Optional | Specifies the API name of the kiosk group. The group API name can be at most 25 characters in length. Maximum length: 25 |
id | string or null | Optional | Specifies 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 |
name | string or null | Optional | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_name | string or null | Optional | Specifies 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 |
id | string or null | Optional | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after updating a kiosk, containing an array of per-item operation results. Additional keys: not allowed |
kiosks | array | Optional | Contains the list of kiosk result objects from the update operation. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Update a Kiosk — response body — kiosks item |
Referenced models: Update a Kiosk — response body — kiosks item
Update a Kiosk — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
code | string | Optional | Represents the result code of the kiosk update operation. Maximum length: 255 |
details | Model | Optional | Expand Update a Kiosk — response body — kiosks item details |
message | string | Optional | Represents the message describing the outcome of the kiosk update operation. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier of the updated kiosk returned as part of the update operation result. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the updated kiosk. Maximum length: 255 |