Zoho: Kiosks states schemas (part 2)
60 Zoho schemas with complete fields and constraints.
← Kiosks states operations · All schemas
Get all states of a kiosk — response body — states states item configured properties null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a configured property associated with a screen state returned in a GET response. Contains the type and detail properties. Additional keys: not allowed |
details | Model | Required within parent | Expand Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details |
type | string | Required within parent | Represents the type of the configured property associated with the screen state. Known values: _merge_field, recipients Maximum length: 255 |
Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details
Get all states of a kiosk — response body — states states item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the summary details object returned for a state by the get all states operation. Contains lightweight screen detail properties when available. The structure of this object depends on the state type. Additional keys: not allowed |
$ (anyOf 1).screen_details | Model | Required within parent | Expand Get all states of a kiosk — response body — states states item details screen details screen details |
$ (anyOf 2) | null | Alternative | Represents the summary details object returned for a state by the get all states operation. Contains lightweight screen detail properties when available. The structure of this object depends on the state type. Additional keys: not allowed |
$ (anyOf 2).screen_details | Model | Required within parent | Expand Get all states of a kiosk — response body — states states item details screen details screen details |
Referenced models: Get all states of a kiosk — response body — states states item details screen details screen details
Get all states of a kiosk — response body — states states item details screen details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary screen details returned for a screen state by the get all states operation. Contains the width, title, and button alignment. Additional keys: not allowed |
button_align | string | Required within parent | Represents the alignment direction of action buttons within the screen footer. **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 |
title | string | Required within parent | Represents the display title shown at the top of the kiosk screen. Maximum length: 255 |
width | string | Required within parent | Represents the visual width of the kiosk screen container. **Possible values:** **670px** **1000px** Known values: 670px, 1000px Maximum length: 255 |
Kiosk State — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body for updating a kiosk state. The states array contains exactly one state object, with the state ID as the only required field. Additional keys: not allowed |
states | array | Required within parent | Represents the array containing exactly one state object to update. Maximum items: 1 Minimum items: 1 |
states[] | Model | Each item | Expand Kiosk State — request body — body states item |
Referenced models: Kiosk State — request body — body states item
Kiosk State — request body — body / states / item / details / add_meeting, add_tags, api_name, assign_owner, convert, create_record, criteria, email_notifications, execute_for_record, field_updates, functions, get_record, note, open_link, open_record, quick_create_record, remove_tags, schedule_call, tasks, type, webhooks / assign_owner / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: assign_to entry for resource-based ownership. MANDATORY: type (user|role|group|assignment_rule|profile), resource ({id, name}). For type=profile: associated_to must be 'team_profile'. For round-robin: use multiple entries of type=user. Additional keys: not allowed |
allow_agent_user | boolean | Optional | Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule. Default: false |
associated_to | string or null | Optional | Association context for profile-based assignment. Must be "team_profile" when type=profile. Not applicable for other assignment types; if provided for a non-profile type, the API returns DEPENDENT_MISMATCH. One of: team_profile, null |
details | null | Optional | Always null for resource-based assignments. Present in GET responses for schema consistency with other assign_to types. |
resource | Model | Required within parent | Expand Kiosk State — request body — body / states / item / details / add_meeting, add_tags, api_name, assign_owner, convert, create_record, criteria, email_notifications, execute_for_record, field_updates, functions, get_record, note, open_link, open_record, quick_create_record, remove_tags, schedule_call, tasks, type, webhooks / assign_owner / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile resource Identifies the target user, role, group, assignment rule, or profile by ID and/or name. At least one of id or name must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING. |
type | string | Required within parent | Assignment method. Determines what kind of entity receives ownership. Values: "user" - assign to a specific CRM user (GET /settings/users), for round-robin include multiple assign_to entries of type=user; "role" - assign to a user holding the specified role (GET /settings/roles), system picks an eligible user at execution time; "group" - assign to a member of the specified user group (GET /settings/user_groups); "assignment_rule" - assign using a pre-configured assignment rule (GET /settings/automation/assignment_rules), the rule's criteria and round-robin logic determine the final owner; "profile" - assign to a user matching the specified profile (GET /settings/profiles), must include associated_to=team_profile. One of: user, role, group, assignment_rule, profile |
Kiosk State — request body — body / states / item / details / add_meeting, add_tags, api_name, assign_owner, convert, create_record, criteria, email_notifications, execute_for_record, field_updates, functions, get_record, note, open_link, open_record, quick_create_record, remove_tags, schedule_call, tasks, type, webhooks / assign_owner / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Resource reference for assign_to entry. MANDATORY: id (string). OPTIONAL: name, type. Obtain from GET /settings/users (user), /settings/roles (role), /settings/user_groups (group), /settings/automation/assignment_rules (assignment_rule), /settings/profiles (profile). If both id and name given, must match (AMBIGUITY_DURING_PROCESSING). Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the target entity. Obtain from the corresponding API: GET /settings/users (for user), GET /settings/roles (for role), GET /settings/user_groups (for group), GET /settings/automation/assignment_rules (for assignment_rule), or GET /settings/profiles (for profile). Maximum length: 255 |
name | string | Optional | Display name of the target entity. Optional in POST/PUT requests (server resolves from id); always present in GET responses. Maximum length: 255 |
type | string | Optional | Type of the target entity. Present in GET responses; not required in POST/PUT requests. One of: user, role, group, assignment_rule, profile |
Kiosk State — request body — body states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the kiosk state update payload. The ID field is the only required property; all other fields are optional and only the included fields are changed. Additional keys: not allowed |
details | JSON | Optional | Represents the state-specific configuration object to be updated. The structure varies by the state type. |
details (anyOf 1) | Model | Alternative | Expand Kiosk State — request body — body states item details screen details |
details (anyOf 2) | Model | Alternative | Expand Kiosk State — request body — body states item details path details |
details (anyOf 3) | Model | Alternative | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks |
details (anyOf 4) | Model | Alternative | Expand Kiosk State — request body — body states item details get record |
from_transition | Model | Optional | Expand Kiosk State — request body — body states item from transition |
id | string | Optional | Represents the unique identifier of the kiosk state to be updated. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the kiosk state. Maximum length: 250 |
type | JSON | Optional | Represents the type of the kiosk state. The value determines the structure of the details object. |
type (anyOf 1) | string | Alternative | Represents the type of the kiosk state. Determines the structure of the details configuration object. Possible values: screen - A visual screen state with form elements. decision - A conditional branching state. action - A CRM operation state. get_records - A record retrieval state. One of: screen, decision, action, get_records |
type (anyOf 2) | null | Alternative | Represents the null variant of the type field, used when updating a state without changing its type. |
$ (allOf 1) | JSON | All variants apply | Represents the screen state variant of the update payload. Applies when the state type is screen. |
$ (allOf 2) | JSON | All variants apply | Represents the decision state variant of the update payload. Applies when the state type is decision. |
$ (allOf 3) | JSON | All variants apply | Represents the action state variant of the update payload. Applies when the state type is action. |
$ (allOf 4) | JSON | All variants apply | Represents the get_records state variant of the update payload. Applies when the state type is get_records. |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks, Kiosk State — request body — body states item details path details, Kiosk State — request body — body states item from transition, Kiosk State — request body — body states item details get record, Kiosk State — request body — body states item details screen details
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for updating a kiosk action state. The structure is composed using allOf to include one or more optional action-type properties depending on the configured action. Additional keys: not allowed |
add_meeting | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting Configuration for the add_meeting action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id), and id (action's id inside "details") is mandatory for update. |
add_tags | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags Configuration for the add_tags action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id), and id (action's id inside "details") is mandatory for update. |
api_name | string or null | Optional | Represents the merge field API name used to dynamically resolve the owner for the assign_owner action. When the user is not provided directly, the merge field expression identifies the user. Supported formats: (1) Record field: `${!<kiosk_group_api_name>.<resource_api_name>.<field_api_name>}` where resource can be `CurrentRecord` or a GetRecord API name. (2) CRM module field: `${!<module_api_name>.<field_api_name>}` for example, `${!users.email}`. (3) Kiosk screen field: `${!<kiosk_group_api_name>.<screen_field_api_name>}`. Maximum length: 200 |
assign_owner | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner Configuration for the assign_owner action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id), and id (action's id inside "details") is mandatory for update. |
convert | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert Configuration for the convert action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id), and id (action's id inside "details") is mandatory for update. |
create_record | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record Configuration for the create_record action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id), and id (action's id inside "details") is mandatory for update. |
criteria | Model | Optional | Expand Related Records — request body — query filters Criteria for ownership assignment comparison. Referenced from Criterion.json. |
email_notifications | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks email notifications Email notifications action will be used to trigger emails with pre-defined template and content to the configured records. This is an associate action and hence this JSON will consist of the email notification action's identifiers like ID and name. It is mandatory for the action to be created before associating in the Kiosk. A specific action can be associated with only one state in the Kiosk. |
execute_for_record | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks execute for record For associate actions and few non associate actions, the action should be performed on a specific record in the CRM system. For example, if the user is creating the field update action to modify a company name, he must provide which record's company name should be changed. So, he should provide either a get record reference or a current record reference in "execute_for_record" key. ID and name of the resource will be enough. However, for actions which are unrelated for a specific record, this key can be ignored. |
field_updates | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks field updates In case the action type is "field_updates", this key is mandatory. It contains the information or identifier of the "Field update" action configured in the workflow. If we give ID of the configured action, it will be associated here. It is mandatory for this field update action id to be associated in only one place or state of the Kiosk. You cannot a single field update action in many action states. |
functions | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks functions Functions is an associated action which will execute a piece of code or other operations upon execution. These functions would have been created either previously or during the creation of the action which can be associated and run during action execution. It acts as a server-side function executed when kiosk is executed. |
get_record | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks get record This is the JSON which contains the association details of the get_record component for a get_records state. |
note | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note Configuration used to create a note associated with a CRM record. For example, a specific Lead detail view page can have a note by running this particular action. |
open_link | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open link Open link is an action used to open a specific link which is configured during state creation when triggered. This json will consist of the link and encoding details. |
open_record | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open record It is an action to open a particular record fetched from the CRM modules. The user will configure either a get record or a current record with this action. The fetched record is opened automatically when the action is executed. |
quick_create_record | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record It is an action used to quickly configure a create record action with minimal field input. However, there will be a pop up during the execution of the action where the user must provide the values for the fields configured. Then, the record will be created. |
remove_tags | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags Configuration for the remove_tags action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id), and id (action's id inside "details") is mandatory for update. |
schedule_call | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call Configuration for the schedule_call action. Referenced from AutomationNonAssociateActions.json. MANDATORY: id (state id) is mandatory for update. |
tasks | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks tasks Tasks is another associate action which helps in assigning tasks to specific records. This JSON will consist of the resource identifiers for the Tasks action in the workflow. |
type | string or null | Optional | Indicates the action type for the kiosk action state. The specified type determines which action configuration object must be present in the details object. One of: field_updates, assign_owner, add_tags, create_record, note, remove_tags, email_notifications, tasks, webhooks, functions, add_meeting, schedule_call, convert, open_record, open_link, quick_create_record Maximum length: 20 |
webhooks | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks webhooks Represents a webhook action that triggers an external HTTP callback when executed. The webhook configuration can be done during the creation of the state. However, these configuration details won't come in the webhook action payload. The payload will only refer the webhook created. |
$ (allOf 1) | JSON | All variants apply | Represents the optional execute_for_record property, which identifies the CRM record or get_record component on which the action is performed. |
$ (allOf 2) | JSON | All variants apply | Represents the optional note property for the add note action. |
$ (allOf 3) | JSON | All variants apply | Represents the optional functions property for the function action. |
$ (allOf 4) | JSON | All variants apply | Represents the optional open_record property for the open record action. |
$ (allOf 5) | JSON | All variants apply | Represents the optional get_record property for associating a get_record component with the action. |
$ (allOf 6) | JSON | All variants apply | Represents the optional criteria property containing the filter conditions used to evaluate ownership assignment. |
$ (allOf 7) | JSON | All variants apply | Represents the optional open_link property for the open link action. |
$ (allOf 8) | JSON | All variants apply | Represents the optional convert property for the convert action. |
$ (allOf 9) | JSON | All variants apply | Represents the type discriminator property that specifies the action type. |
$ (allOf 10) | JSON | All variants apply | Represents the optional create_record property for the create record action. |
$ (allOf 11) | JSON | All variants apply | Represents the optional assign_owner property for the assign owner action, including the criteria or merge field used to resolve the owner. |
$ (allOf 12) | JSON | All variants apply | Represents the optional remove_tags property for the remove tags action. |
$ (allOf 13) | JSON | All variants apply | Represents the optional add_meeting property for the add meeting action. |
$ (allOf 14) | JSON | All variants apply | Represents the optional webhooks property for the webhook action. |
$ (allOf 15) | JSON | All variants apply | Represents the optional api_name property containing the merge field expression used to resolve the owner dynamically for the assign_owner action. |
$ (allOf 16) | JSON | All variants apply | Represents the optional email_notifications property for the email notification action. |
$ (allOf 17) | JSON | All variants apply | Represents the optional field_updates property for the field update action. |
$ (allOf 18) | JSON | All variants apply | Represents the optional quick_create_record property for the quick create record action. |
$ (allOf 19) | JSON | All variants apply | Represents the optional tasks property for the tasks action. |
$ (allOf 20) | JSON | All variants apply | Represents the optional schedule_call property for the schedule call action. |
$ (allOf 21) | JSON | All variants apply | Represents the optional add_tags property for the add tags action. |
$ (allOf 22) | JSON | All variants apply | Represents the optional sequential_action_details property for configuring whether the action runs sequentially and handles failure paths. |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks email notifications, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks execute for record, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks field updates, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks functions, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks get record, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open link, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open record, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks tasks, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks webhooks, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call, Related Records — request body — query filters, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for add_meeting action. Creates an Event record when workflow fires. PREREQUISITES: GET /settings/layouts?module=Events for layout + mandatory fields. GET /settings/fields?module=Events for field ids. MANDATORY: module ({api_name: 'Events', id}), layout ({id}), field_mappings (array 1-25, include Event_Title, Start_DateTime), meeting_duration ({unit: int, period: 'hours'|'minutes'} - NOT when All_Day=true), host_unavailable ({assign_record_owner_as_host: true} or {assign_task: {id}}). OPTIONAL: apply_restriction (bool). Additional keys: not allowed |
apply_restriction | boolean or null | Optional | Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the Event record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured. Default: false |
field_mappings | array | Required within parent | Field mappings for the new Event. Each entry: {"field": {"api_name": "Event_Title"}, "type": "static", "value": "Meeting"}. Must include all mandatory fields from GET /settings/layouts?module=Events. Common fields: Event_Title, Start_DateTime, All_Day, Participants (composite type), Remind_At. End_DateTime is auto-computed from Start_DateTime + meeting_duration - do NOT provide it. Mapping types: static - literal values for text, picklist fields; NOT for DateTime/ALARM (DEPENDENT_MISMATCH). merge_field - runtime tokens like ${!Leads.Company} for text-based fields; NOT for lookup/owner (DEPENDENT_MISMATCH). execution_time - REQUIRED for Start_DateTime and Remind_At; sign required for datetime; periods: days, business_days, hours, minutes. When All_Day=true, period must be "days" and omit meeting_duration. Maximum items: 25 Minimum items: 1 |
field_mappings[] | Model | Each item | Expand Create an Automation Task — request body — body tasks item field mappings item Represents a single field-to-value mapping entry for the new Event record, conforming to the AutomationFieldMappings schema. Each entry identifies a target Event field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved DateTime and ALARM fields. |
host_unavailable | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting host unavailable Fallback behavior when the designated meeting host is unavailable. Either assign the record owner as host (assign_record_owner_as_host=true) or create a follow-up task (assign_task with a pre-configured task ID). Exactly one option must be specified; providing both returns INVALID_DATA with field1/field2 conflict, providing neither returns EXPECTED_FIELD_MISSING. |
id | string | Optional | Server-generated unique identifier for this add meeting action. Present only in GET responses; not required in POST requests. Maximum length: 20 |
layout | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout Layout to use when creating the Event record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module=Events. The layout.id is required. |
meeting_duration | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting meeting duration Duration of the meeting. Specifies a numeric value and time period (e.g., 1 hour, 30 minutes). Required when All_Day is not set to true in field_mappings. If All_Day is true, meeting_duration must not be provided - the API returns INVALID_DATA with field1/field2 conflict details. |
module | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module for the meeting. Must be the Events module. Provide either api_name ("Events") or the Events module id. |
Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting host unavailable, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting meeting duration
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting host unavailable
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Fallback when meeting host or caller is unavailable. Exactly ONE must be specified: assign_record_owner_as_host (bool) OR assign_task ({id}). Both = INVALID_DATA. Neither = EXPECTED_FIELD_MISSING. Additional keys: not allowed |
assign_record_owner_as_host | boolean | Optional | When true, the record owner is automatically assigned as the host/caller if the originally designated host is unavailable. Mutually exclusive with assign_task. |
assign_task | object or null | Optional | A follow-up task to create when the host is unavailable. Mutually exclusive with assign_record_owner_as_host. The task must be pre-configured in the CRM. Additional keys: not allowed |
assign_task.id | string | Required within parent | Unique ID of the pre-configured task. Maximum length: 20 |
assign_task.name | string | Optional | Name of the follow-up task. Maximum length: 255 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Layout reference for create_record, add_meeting, schedule_call actions. MANDATORY: id (string). Determines field availability and validation rules. GET /settings/layouts?module={api_name} to discover. Additional keys: not allowed |
display_label | string | Optional | Human-readable label of the layout. Present in GET responses. Maximum length: 50 |
id | string | Required within parent | Unique layout ID. Required. Obtain from GET /settings/layouts?module={module_api_name}. Maximum length: 20 |
name | string or null | Optional | Display name of the layout. Optional in requests; present in GET responses. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting meeting duration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Meeting duration for add_meeting. MANDATORY unless All_Day=true. REQUIRED: unit (integer - quantity), period (string - 'hours' or 'minutes'). Must be a JSON object (not int/string - INVALID_DATA). Omitting returns MANDATORY_NOT_FOUND. If All_Day=true and provided, returns INVALID_DATA (field1/field2 conflict). EXAMPLE: {"unit": 1, "period": "hours"} Additional keys: not allowed |
period | string | Required within parent | The time unit for the duration. "hours" - duration in hours (e.g., unit=1, period=hours means a 1-hour meeting). "minutes" - duration in minutes (e.g., unit=30, period=minutes means a 30-minute meeting). One of: hours, minutes Maximum length: 10 |
unit | integer | Required within parent | The numeric duration value (e.g., 1, 2, 30). Format: int32 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for add_tags action. Adds pre-existing tags to the triggering record. PREREQUISITES: Tags must exist - GET /settings/tags?module={api_name} to list, POST to create first. MANDATORY: tags (array 1-10, each {id, name}). OPTIONAL: over_write (bool, default false - true replaces ALL existing tags), module ({api_name, id}). CONSTRAINTS: Not allowed with convert on Leads (AMBIGUITY_DURING_PROCESSING). over_write=true + remove_tags in same rule = INVALID_DATA. Unsupported: Visits, Users, LinkingModules (NOT_ALLOWED). Additional keys: not allowed |
id | string | Optional | Server-generated unique identifier for this add tags action. Present only in GET responses; not required in POST requests. Maximum length: 20 |
module | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module for the tag action. Must match the workflow rule's trigger module. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, and custom modules. Unsupported modules (Visits, Users, LinkingModules) return NOT_ALLOWED. |
over_write | boolean | Optional | Whether to overwrite all existing tags on the record with the specified tags (true) or append to existing tags (false). Default is false. When set to true, any RemoveTags action in the same workflow rule becomes invalid and returns INVALID_DATA ('Remove tag not supported with Overwrite Add Tag'). Default: false |
tags | array | Required within parent | List of tags to add to the record. All tags must pre-exist in the org - fetch available tags from GET /settings/tags?module={module_api_name}. To create new tags: POST /settings/tags?module={module_api_name}. If the list is empty after parsing, the API returns FAILURE ('Empty Tag'). If the tag count exceeds the edition limit, the API returns FAILURE ('Invalid Tag Count'). Maximum items: 10 Minimum items: 1 |
tags[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags tags item Represents a tag reference, conforming to the AutomationTagRef schema, that identifies a pre-existing org tag to be added to the record. Both id and name are mandatory fields on each entry; the referenced tag must already exist in the org before the action executes. |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags tags item
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Module reference used across non-associate actions. At least one of api_name or id required (EXPECTED_FIELD_MISSING if neither). If both given, must match (AMBIGUITY_DURING_PROCESSING). GET /settings/modules to discover. Always use full 19-digit module ID. Minimum fields: 1 Additional keys: not allowed |
api_name | string | Optional | API name of the module (e.g., Leads, Contacts, Deals, Vendors). Maximum length: 255 |
id | string | Optional | Unique module ID (19-digit format). Always use the full ID as returned by GET /settings/modules - truncated or shortened IDs return INVALID_DATA ('the tabId given seems to be invalid'). Optional in requests if api_name is provided; always present in responses. Maximum length: 20 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags tags item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Tag reference for add_tags/remove_tags. Tags must pre-exist - GET /settings/tags?module={api_name} to list, POST to create. MANDATORY: id, name. Both must resolve to same tag (AMBIGUITY_DURING_PROCESSING if mismatch). Non-existent = INVALID_DATA. Limits: 100 tags/module, 10 tags/record, name max 25 chars. Additional keys: not allowed |
color_code | string | Optional | Hex color code of the tag (e.g., '#879BFC'). Optional in requests; present in GET responses. Allowed values: #F17574, #F48435, #E7A826, #A8C026, #63C57E, #1DB9B4, #57B1FD, #879BFC, #D297EE, #FD87BD, #969696, #658BA8, #B88562. Maximum length: 25 |
id | string | Required within parent | Unique identifier of the tag. Obtain from GET /settings/tags?module={module_api_name}. If provided alone, the tag is resolved by ID. If both id and name are provided, they must resolve to the same tag. Maximum length: 20 |
name | string | Required within parent | Name of the tag. Obtain from GET /settings/tags?module={module_api_name}. If provided alone, the tag is resolved by name. Must match an existing tag - providing a non-existent name returns INVALID_DATA. Max 25 characters, cannot contain <, >, commas, or emojis. Maximum length: 25 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for assign_owner action. Assigns/reassigns record owner via user, role, group, profile, assignment_rule, merge_field, or criteria. MANDATORY: module ({api_name, id} - must match trigger module), assign_to (array 1-5 entries). OPTIONAL: notify (bool), related_records ([{api_name, id}] - Tasks/Calls/Events), apply_assignment_threshold (bool), user_availability_based_on, lookup_field (for cross-module). EXAMPLE: {"module": {"api_name": "Leads", "id": "111111000000000175"}, "assign_to": [{"type": "user", "resource": {"id": "111111000000050001", "name": "John"}}], "notify": true} Additional keys: not allowed |
apply_assignment_threshold | boolean | Optional | Whether to enforce assignment-threshold rules (record count limits per user) when assigning ownership. When true, the system checks whether the new owner has reached their record limit before applying the assignment. Only effective when the org has assignment thresholds configured. Default: false |
assign_to | array | Required within parent | Specifies how the new owner is determined. Each entry defines an assignment method - a specific user, role, group, assignment rule, profile, merge field, or criteria-based filter. For round-robin assignment across multiple users, provide multiple entries of type=user. For criteria-based assignment, provide a single entry of type=criteria with filter conditions. Maximum items: 5 Minimum items: 1 |
assign_to[] | JSON | Each item | Represents a single owner-assignment entry that determines how the new record owner is resolved. Each entry is one of three variants: AutomationAssignToResourceEntry (assigns ownership to a specific user, role, group, assignment rule, or profile), AutomationAssignToMergeFieldEntry (resolves the owner at runtime from a user-type lookup field on the trigger record), or AutomationAssignToCriteriaEntry (determines the owner by evaluating filter criteria at runtime). |
assign_to[] (anyOf 1) | Model | Alternative | Expand Kiosk State — request body — body / states / item / details / add_meeting, add_tags, api_name, assign_owner, convert, create_record, criteria, email_notifications, execute_for_record, field_updates, functions, get_record, note, open_link, open_record, quick_create_record, remove_tags, schedule_call, tasks, type, webhooks / assign_owner / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile |
assign_to[] (anyOf 2) | Model | Alternative | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner assign to item type merge field |
assign_to[] (anyOf 3) | Model | Alternative | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner assign to item type criteria |
id | string | Optional | Server-generated unique identifier for this assign owner action. Present only in GET responses; not required in POST or PUT requests. Maximum length: 20 |
lookup_field | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner lookup field The lookup field linking the trigger module to the target module. Required only for cross-module assign owner actions (where the action's module differs from the workflow rule's trigger module). For same-module assignments, this field is omitted and the action operates directly on the triggering record. |
module | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module for the ownership assignment. Must match the workflow rule's trigger module for direct assignments, or the lookup field's related module for cross-module assignments. At least api_name or id must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING. |
notify | boolean | Optional | Whether to send an email notification to the new owner when the record is reassigned. When true, the newly assigned owner receives an email informing them of the ownership change. Default: false |
related_records | array or null | Optional | Related modules whose open record ownership should also be transferred when the parent record is reassigned. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when no related modules are selected for ownership transfer. Maximum items: 5 |
related_records[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner related records item |
user_availability_based_on | array or null | Optional | Restricts assignment to users who are currently available. When set to ["online_status"], only users logged in to the Zoho CRM web interface are eligible for assignment. If the selected user is offline, the assignment is skipped or deferred. Null means no availability check is applied. Maximum items: 1 |
user_availability_based_on[] | string | Each item | Availability criterion. Currently only "online_status" is supported - restricts to users currently logged in to Zoho CRM web interface. One of: online_status |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner assign to item type criteria, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner assign to item type merge field, Kiosk State — request body — body / states / item / details / add_meeting, add_tags, api_name, assign_owner, convert, create_record, criteria, email_notifications, execute_for_record, field_updates, functions, get_record, note, open_link, open_record, quick_create_record, remove_tags, schedule_call, tasks, type, webhooks / assign_owner / assign_to / item / associated_to: team profile, None, type: user, role, group, assignment rule, profile, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner lookup field, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner related records item
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner assign to item type criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: assign_to entry for criteria-based ownership. Evaluates filter criteria against the triggering record at execution time. MANDATORY: type (const 'criteria'), details.criteria (filter condition - simple or grouped with AND/OR). Criteria fields must reference valid trigger module fields - GET /settings/fields?module={api_name}. Additional keys: not allowed |
allow_agent_user | boolean | Optional | Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule. Default: false |
details | object | Required within parent | Contains the filter criteria to evaluate against the triggering record. Additional keys: not allowed |
details.criteria | Model | Required within parent | Expand Related Records — request body — query filters Filter criteria defining when this assignment applies. Can be a simple condition (field + comparator + value) or a grouped condition (group_operator + group array). The field references in criteria must be valid fields of the trigger module - fetch available fields from GET /settings/fields?module={module_api_name}. For example: {"field": {"api_name": "Department"}, "comparator": "equal", "value": "Engineering"} assigns ownership when the record's Department is Engineering. |
resource | null | Optional | Always null for criteria-based assignments. The owner is determined by the criteria evaluation logic. |
type | string | Required within parent | Assignment method indicating criteria-based evaluation. Must equal: criteria |
Referenced models: Related Records — request body — query filters
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner assign to item type merge field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: assign_to entry for merge-field-based ownership. Resolves to a user at execution time from a user-type field. MANDATORY: type (const 'merge_field'), details.api_name (merge field token e.g., '${!Leads.Created_By}'). Field must be data_type=ownerlookup or userlookup. GET /settings/fields?module={api_name} to discover. Additional keys: not allowed |
allow_agent_user | boolean | Optional | Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule. Default: false |
details | object | Required within parent | Contains the merge field reference that resolves to a user at execution time. Additional keys: not allowed |
details.api_name | string | Required within parent | Merge field token referencing a user-type field. Must use the format ${!Module.User_Field} ,${!Module.Lookup_Field_API_Name.User_Field} where Field is a user-type field (data_type=ownerlookup or userlookup) from the trigger module. Fetch valid fields from GET /settings/fields?module={module_api_name}. Common user-type fields: Owner, Created_By, Modified_By. Examples: ${!Leads.Created_By}, ${!Deals.Owner}, ${!Contacts.Account_Manager}. Maximum length: 255 |
resource | null | Optional | Always null for merge field assignments. The owner is resolved dynamically from the merge field at execution time. |
type | string | Required within parent | Assignment method indicating merge field resolution. Must equal: merge_field |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner lookup field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifies a lookup field that links the workflow rule's trigger module to the target module of a cross-module action. For example, if the trigger module is Leads and the assign owner action targets Contacts, the lookup_field identifies which lookup field on Leads points to Contacts (e.g., Lookup_2_cont). Minimum fields: 1 Additional keys: not allowed |
api_name | string | Optional | API name of the lookup field (e.g., Lookup_1_same, Lookup_2_cont). Maximum length: 255 |
id | string | Optional | Unique field ID of the lookup field. Maximum length: 20 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner related records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifies a related module whose open records' ownership should be transferred alongside the parent record. Used by assign_owner actions, field_updates (Owner field), and convert actions (change_owner.related_modules). Common activity modules (Tasks, Calls, Events) are available for all modules and actions. Contacts is available for assign_owner when parent is Accounts, and for convert when converting Leads. Deals is available for assign_owner when parent is Accounts or Contacts, and for convert when converting Leads (requires create_deal=true). Additional keys: not allowed |
api_name | string | Required within parent | API name of the related module. Events, Calls, Tasks - open activity records, available for all modules and actions (assign_owner, convert). Contacts - available for assign_owner when parent is Accounts, and for convert when converting Leads. Deals - available for assign_owner when parent is Accounts or Contacts, and for convert when converting Leads (requires create_deal=true). One of: Events, Calls, Tasks, Contacts, Deals Maximum length: 255 |
id | string | Optional | Unique identifier of the related module. This is the module ID corresponding to the api_name. Maximum length: 255 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for convert action. Converts records - Leads to Contacts+Accounts+Deals, Quotes to SalesOrders/Invoices, SalesOrders to Invoices. PREREQUISITES: criteria_details.criteria MUST be non-null (NOT_ALLOWED otherwise). Module MUST be Leads/Quotes/Sales_Orders. MANDATORY (Leads): add_to_existing_contact (bool), add_to_existing_account (bool). MANDATORY (Quotes/Sales_Orders): convert_to ({api_name, id}). OPTIONAL: change_owner, carry_tags (ARRAY [{api_name, id}] NOT boolean), field_mappings (max 25), move_attachment_to, create_deal (Leads only), contact_role (with create_deal). CONSTRAINTS: No add_tags/remove_tags with convert on Leads. No scheduled actions with convert. Additional keys: not allowed |
add_to_existing_account | boolean | Optional | MANDATORY for Leads conversion (omitting returns MANDATORY_NOT_FOUND). Whether to link the converted record to an existing Account instead of creating a new one. Only applicable for Leads module. When true, if a matching Account exists (based on Company name), the Lead is linked to it rather than creating a new Account. Not applicable for Quotes or Sales_Orders conversions. Default: false |
add_to_existing_contact | boolean | Optional | MANDATORY for Leads conversion (omitting returns MANDATORY_NOT_FOUND). Whether to link the converted record to an existing Contact instead of creating a new one. Only applicable for Leads module. When true, if a matching Contact exists (based on duplicate-check criteria), the Lead is merged into it rather than creating a new Contact. Not applicable for Quotes or Sales_Orders conversions. Default: false |
apply_restriction | boolean or null | Optional | Whether to enforce assignment-threshold rules on the record owner during conversion. Present in GET responses. Default: false |
carry_tags | array | Optional | List of target modules that should inherit tags from the source record during conversion. For Leads: may include Contacts, Accounts, Deals. Each entry identifies a module by api_name and/or id. Maximum items: 10 |
carry_tags[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Represents a module reference, conforming to the AutomationModuleRef schema, that identifies a target module whose records should inherit tags from the source record during conversion. At least one of api_name or id is required to identify the module; valid values are obtainable from GET /settings/modules. |
change_owner | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert change owner New owner assignment for the converted records. Specifies the user (by id) who should own the converted records, which modules should receive the new owner (via related_modules), and whether to enforce assignment thresholds. When omitted, the source record's owner is retained. |
contact_role | string | Optional | Unique ID of the Contact Role to assign when a Deal is created during Leads conversion. Only applicable when create_deal=true. Obtain valid Contact Role IDs from GET /Contacts/roles. Maximum length: 20 |
convert_to | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert convert to |
create_deal | boolean | Optional | Whether to create a Deal record as part of Leads conversion. Only applicable when the trigger module is Leads. When true, the Deal module field mappings in field_mappings are used to populate the new Deal. Default: false |
field_mappings | array | Optional | List of field-value pairs to populate in the converted record(s). Each entry maps a target field to a value using one of the supported types: static, merge_field, or execution_time. For Leads conversion, field mappings can target Contacts, Accounts, and Deals modules. Fetch available fields from GET /settings/fields?module={target_module_api_name}. Maximum items: 25 |
field_mappings[] | Model | Each item | Expand Create an Automation Task — request body — body tasks item field mappings item Represents a single field-to-value mapping entry for the converted record, conforming to the AutomationFieldMappings schema. Each entry identifies the target field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved values. |
id | string | Optional | Server-generated unique identifier for this convert action. Present only in GET responses; not required in POST requests. Maximum length: 20 |
move_attachment_to | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module to which attachments from the source record should be moved during conversion. For Leads: typically Contacts or Accounts. For Quotes/SalesOrders: the target conversion module. Provide api_name and/or id. |
portal_user_type | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert portal user type |
Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert change owner, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert convert to, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert portal user type
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert change owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Owner assignment during convert action. MANDATORY: id (user ID from GET /users). OPTIONAL: name, related_modules ([{api_name, id}] - which converted modules get new owner), apply_assignment_threshold (bool). For Leads: related_modules can include Events, Calls, Tasks, Contacts, Deals. Additional keys: not allowed |
apply_assignment_threshold | boolean | Optional | Whether to enforce assignment-threshold rules (record count limits per user) on the new owner for each converted module. When true, the system checks whether the new owner has reached their record limit before assigning ownership. Default: false |
id | string | Required within parent | Unique user ID of the new owner. Obtain from GET /users. Must be an active user with permissions on the target modules. Maximum length: 20 |
name | string | Optional | Full name of the new owner. Optional - present in GET responses for display purposes. Maximum length: 255 |
related_modules | array | Optional | List of target modules whose records should receive the new owner during conversion. Reuses the same related-record concept as assign_owner. For Leads conversion: Events, Calls, Tasks, Contacts, Deals are valid. For Quotes/SalesOrders conversion: only Events, Calls, Tasks are valid. Maximum items: 10 |
related_modules[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks assign owner related records item Represents a related module reference, conforming to the AutomationRelatedRecord schema, that identifies a child module whose records should also receive the new owner assignment during the conversion operation. At least one of api_name or id is required to identify the child module. |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert convert to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | MANDATORY for Quotes and Sales_Orders conversion (omitting returns MANDATORY_NOT_FOUND). Identifies the target module for conversion as an object with api_name and id. For Quotes: convert_to can be {api_name: 'SalesOrders', id: '<module_id>'} or {api_name: 'Invoices', id: '<module_id>'}. For Sales_Orders: convert_to must be {api_name: 'Invoices', id: '<module_id>'}. Obtain the module id from GET /settings/modules. Not applicable for Leads conversion (Leads always convert to Contacts+Accounts, optionally +Deals). Additional keys: not allowed |
api_name | string | Required within parent | API name of the target module. For Quotes: 'SalesOrders' or 'Invoices'. For Sales_Orders: 'Invoices'. Maximum length: 50 |
id | string | Required within parent | Unique 19-digit module ID of the target module. Obtain from GET /settings/modules. Always use the full 19-digit ID as returned by the API; truncated IDs cause INVALID_DATA. Maximum length: 20 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks convert portal user type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Portal user type to assign during Leads conversion. Only applicable when the org has portals configured and the converted Contact should be provisioned as a portal user. The id and name must match an existing portal user type - validated against the org's portal metadata (CrmClientPortalFilterUtil). Not applicable for Quotes or Sales_Orders conversions. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the portal user type. Must match an existing portal user type in the org's portal configuration. Maximum length: 20 |
name | string | Required within parent | Display name of the portal user type. Maximum length: 100 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks create record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for create_record action. Creates a record in a module with field values from static data, merge fields, or execution-time refs. NOT for Tasks/Events/Calls (use tasks, add_meeting, schedule_call). PREREQUISITES: GET /settings/modules for id. GET /settings/layouts?module={api_name} for layout + mandatory fields. GET /settings/fields?module={api_name} for field ids. MANDATORY: module ({api_name, id}), layout ({id}), field_mappings (array 1-25, include all mandatory fields). OPTIONAL: apply_restriction (bool). EXAMPLE: {"module": {"api_name": "Contacts", "id": "111111000000000129"}, "layout": {"id": "111111000000000403"}, "field_mappings": [{"field": {"api_name": "Last_Name"}, "type": "merge_field", "value": "${!Leads.Last_Name}"}]} Additional keys: not allowed |
apply_restriction | boolean or null | Optional | Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured. Default: false |
field_mappings | array | Required within parent | Field mappings for the new record. Each entry: {"field": {"api_name": "Last_Name"}, "type": "static", "value": "Test"}. Must include all mandatory fields (system_mandatory=true or api_mandatory=true from GET /settings/layouts?module={module}) - missing ones cause REQUIRED_DATA_NOT_FOUND. Mapping types: static - literal values for text, picklist, phone, number fields; NOT for Date/DateTime/ALARM (DEPENDENT_MISMATCH) or unique fields (INVALID_DATA, check unique=true in GET /settings/fields). merge_field - runtime tokens like ${!Leads.Company} for text-based fields; NOT for lookup/owner fields (DEPENDENT_MISMATCH). execution_time - REQUIRED for Date/DateTime/ALARM fields; periods: days, business_days, hours, minutes; sign required for datetime fields. Maximum items: 25 Minimum items: 1 |
field_mappings[] | Model | Each item | Expand Create an Automation Task — request body — body tasks item field mappings item Represents a single field-to-value mapping entry for the new record, conforming to the AutomationFieldMappings schema. Each entry identifies the target field via a field reference and specifies the value resolution strategy through a type discriminator: static for literal values, merge_field for runtime token substitution, execution_time for dynamically resolved values, or composite for compound values. |
id | string | Optional | Server-generated unique identifier for this create record action. Present only in GET responses; not required in POST requests. Maximum length: 20 |
layout | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout Layout to use when creating the record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module={module_api_name}. The layout.id is required. |
module | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module in which the new record will be created. Supported modules: Leads, Contacts, Potentials (Deals), Accounts, Products, Cases, custom modules, and team modules. NOT supported: Tasks, Events, Calls - use add_meeting for Events and schedule_call for Calls. Fetch available modules from GET /settings/modules. At least api_name or id must be provided; always use the full 19-digit module ID as returned by the modules API. |
Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks email notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the email notification action configuration for updating a kiosk action state. Contains the identifier and name of the pre-created email notification workflow action. Additional keys: not allowed |
id | string | Optional | Represents the record ID of the email notification action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Maximum length: 20 |
name | string or null | Optional | Represents the name of the email notification action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks execute for record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the resource reference used to identify the CRM record on which an action is performed when updating a kiosk state. The resource can be either a get_record component or a current_record reference. Additional keys: not allowed |
id | string or null | Optional | Represents the ID of the resource used for the action. This ID identifies the specific get_record or current_record component to be retrieved when performing the action. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the resource used for the action. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks field updates
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the field update action configuration for updating a kiosk action state. Contains the identifier and name of the pre-created field update workflow action. Additional keys: not allowed |
id | string | Optional | Represents the record ID of the field update action associated with the kiosk action state. Maximum length: 20 |
name | string or null | Optional | Represents the name of the field update action associated with the kiosk action state. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks functions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the function action configuration for updating a kiosk action state. Contains the identifier and name of the pre-created function workflow action. Additional keys: not allowed |
id | string | Optional | Represents the record ID of the function action pre-created in Zoho CRM workflow and associated with the kiosk action state. Format: int64 |
name | string or null | Optional | Represents the name of the function action pre-created in Zoho CRM workflow and associated with the kiosk action state. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the association details for linking an existing get_record component to a kiosk state during an update. Additional keys: not allowed |
id | string or null | Optional | Represents the ID of the get_record component associated with this kiosk state. Maximum length: 18 |
name | string or null | Optional | Represents the name of the get_record component associated with this kiosk state. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the note configuration for updating the add note action. Defines the module, content, title, and optional attachments of the note to be updated. Additional keys: not allowed |
attachments | array or null | Optional | Represents the list of attachments for the note created by the add note action. Each object contains a merge field reference to a File Upload field. Maximum items: 10 |
attachments[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note attachments item |
content | string or null | Optional | Represents the content of the note displayed on the record detail view. Maximum length: 5000 |
module | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module Specifies the CRM module to which the note will be associated. For example, Leads module can have a note associated with it. |
title | string or null | Optional | Represents the title of the note associated with the CRM record. Maximum length: 50 |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note attachments item, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single attachment entry for a note created by the add note action. Each entry contains a merge field reference to a File Upload field. Additional keys: not allowed |
id | string or null | Optional | Represents a merge field reference to a File Upload field. Three formats are supported: (1) Record field — `${!<kiosk_group_api_name>.<resource_api_name>.<field_api_name>}`, where the resource is `CurrentRecord` or a GetRecord API name (for example, `GetRecords_1`). (2) CRM module field — `${!<module_api_name>.<field_api_name>}`, for example, `${!users.email}`. (3) Kiosk screen field — `${!<kiosk_group_api_name>.<screen_field_api_name>}`, which references a File Upload field on a kiosk screen. Maximum length: 200 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the CRM module reference for the meeting action. Identifies the module to use when creating the meeting event. Additional keys: not allowed |
api_name | string or null | Optional | Represents the API name of the CRM module to use when creating the meeting event. Maximum length: 50 |
id | string or null | Optional | Represents the unique identifier of the CRM module to use when creating the meeting event. Maximum length: 19 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open link
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the open link action configuration for updating a kiosk action state, including the URL and character encoding. Additional keys: not allowed |
encode | string or null | Optional | Represents the character encoding used when opening the URL, for example, UTF-8. One of: UTF-8, UTF-16, ISO-8859-1, ISO-8859-9, GB2312, Big5, Shift_JIS Maximum length: 50 |
link | string or null | Optional | Represents the URL to be opened when the action is executed. The value must be a valid URL. Maximum length: 1000 |
name | string or null | Optional | Represents the display name of the open link action state. Maximum length: 250 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks open record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the open record action configuration for updating a kiosk action state. Identifies the record to be opened when the action is triggered, using either a get_record or current_record reference. Additional keys: not allowed |
id | string or null | Optional | Represents the unique ID of the open record action. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the open record action state. Maximum length: 250 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record layout, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks note module, Create an Automation Task — request body — body tasks item field mappings item
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks quick create record layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the layout configuration for the meeting event being updated in the kiosk action. Additional keys: not allowed |
id | string or null | Optional | Represents the layout ID for the meeting event being created. Maximum length: 19 |
name | string or null | Optional | Represents the API name of the layout for the meeting event being created. Maximum length: 50 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks remove tags
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for remove_tags action. Removes tags from the triggering record. PREREQUISITES: Tags must exist - GET /settings/tags?module={api_name} to list. MANDATORY: tags (array 1-10, each {id, name}). OPTIONAL: module ({api_name, id}). CONSTRAINTS: Not allowed with convert on Leads (AMBIGUITY_DURING_PROCESSING). If same rule has add_tags with over_write=true, this returns INVALID_DATA. Unsupported: Visits, Users, LinkingModules (NOT_ALLOWED). Note: over_write field is type-checked but its value is ignored for remove_tags. Additional keys: not allowed |
id | string | Optional | Server-generated unique identifier for this remove tags action. Present only in GET responses; not required in POST or PUT requests. Maximum length: 20 |
module | Model | Optional | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module for the tag action. Must match the workflow rule's trigger module. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, and custom modules. Unsupported modules (Visits, Users, LinkingModules) return NOT_ALLOWED. |
over_write | boolean | Optional | Present in GET responses. Its value is ignored for remove_tags actions. Default: false |
tags | array | Required within parent | List of tags to remove from the record. All tags must pre-exist in the org - fetch available tags from GET /settings/tags?module={module_api_name}. If the list is empty after parsing, the API returns FAILURE ('Empty Tag'). If the tag count exceeds the edition limit, the API returns FAILURE ('Invalid Tag Count'). Maximum items: 10 Minimum items: 1 |
tags[] | Model | Each item | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags tags item Represents a tag reference, conforming to the AutomationTagRef schema, that identifies a pre-existing org tag to be removed from the record. Both id and name are mandatory fields on each entry; the referenced tag must already exist in the org before the action executes. |
Referenced models: Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags tags item
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks schedule call
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | PURPOSE: Details object for schedule_call action. Creates a Call record when workflow fires. PREREQUISITES: GET /settings/layouts?module=Calls for layout + mandatory fields. GET /settings/fields?module=Calls for field ids. MANDATORY: module ({api_name: 'Calls', id}), layout ({id}), field_mappings (array 1-25, include Subject, Call_Type). OPTIONAL: apply_restriction (bool). KEY FIELDS: Subject, Call_Type ('Outbound'|'Inbound'|'Missed'), Call_Purpose, Call_Start_Time, Remind_At. Additional keys: not allowed |
apply_restriction | boolean or null | Optional | Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the Call record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured. Default: false |
field_mappings | array | Required within parent | Field mappings for the new Call. Each entry: {"field": {"api_name": "Subject"}, "type": "static", "value": "Follow-up"}. Must include all mandatory fields from GET /settings/layouts?module=Calls. Call_Type is system-mandatory (values: "Outbound", "Inbound", "Missed") - omitting returns REQUIRED_DATA_NOT_FOUND. Common fields: Subject, Call_Type, Call_Purpose, Call_Start_Time, Remind_At. Mapping types: static - literal values for text, picklist fields; NOT for DateTime/ALARM (DEPENDENT_MISMATCH). merge_field - runtime tokens like ${!Leads.Phone} for text-based fields; NOT for lookup/owner (DEPENDENT_MISMATCH). execution_time - REQUIRED for Call_Start_Time and Remind_At; sign required for datetime; periods: days, business_days, hours, minutes. Maximum items: 25 Minimum items: 1 |
field_mappings[] | Model | Each item | Expand Create an Automation Task — request body — body tasks item field mappings item Represents a single field-to-value mapping entry for the new Call record, conforming to the AutomationFieldMappings schema. Each entry identifies a target Call field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved DateTime and ALARM fields. |
id | string | Optional | Server-generated unique identifier for this schedule call action. Present only in GET responses; not required in POST requests. Maximum length: 20 |
layout | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout Layout to use when creating the Call record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module=Calls. The layout.id is required. |
module | Model | Required within parent | Expand Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module Target module for the call. Must be the Calls module. Provide either api_name ("Calls") or the Calls module id. |
Referenced models: Create an Automation Task — request body — body tasks item field mappings item, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add meeting layout, Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks add tags module
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks tasks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the tasks action configuration for updating a kiosk action state. Contains the identifier and name of the pre-created tasks workflow action. Additional keys: not allowed |
id | string | Optional | Represents the record ID of the task action pre-created in Zoho CRM Workflow and associated with the kiosk state. Each task action can be associated with only one kiosk state. Maximum length: 255 |
name | string or null | Optional | Represents the name of the task action pre-created in Zoho CRM Workflow and associated with the kiosk state. Maximum length: 250 |
Kiosk State — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks webhooks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the webhook action configuration for updating a kiosk action state. Contains the identifier and name of the pre-created webhook workflow action. Additional keys: not allowed |
id | string | Optional | Represents the record ID of the webhook action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Format: int64 Maximum length: 20 |
name | string or null | Optional | Represents the name of the webhook action pre-created in Zoho CRM Workflow and associated with the kiosk action state. Maximum length: 20 |
Kiosk State — request body — body states item details get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for updating a kiosk get_records state. Contains the reference to the get_record component that defines which records to retrieve. Additional keys: not allowed |
get_record | object | Optional | Represents the reference to the get_record configuration that defines which records to retrieve. Additional keys: not allowed |
get_record.id | string or null | Optional | Represents the unique identifier of the get_record configuration. Maximum length: 255 |
get_record.name | string or null | Optional | Represents the display name of the get_record configuration. Maximum length: 255 |
Kiosk State — request body — body states item details path details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for a kiosk decision state. Contains the path definitions, filter conditions, and criteria groupings that determine the branching logic. Additional keys: not allowed |
path_details | array | Required within parent | Represents the list of decision paths the kiosk can follow. Each path includes filter conditions that are evaluated to determine the routing; the default fallback path may have null filter conditions. Maximum items: 10 Minimum items: 1 |
path_details[] | Model | Each item | Expand Kiosk State — request body — body states item details path details path details item |
Referenced models: Kiosk State — request body — body states item details path details path details item
Kiosk State — request body — body states item details path details path details item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single decision path within a kiosk decision state. Each path includes a name, a default flag, and filter conditions that determine whether the path is taken. Additional keys: not allowed |
default | boolean or null | Optional | Indicates whether this path is the default fallback path. When set to **true**, the filter_conditions may be null, and the kiosk follows this path if no other path's conditions are satisfied. Possible values: true - This path is the default fallback. false - This path requires filter conditions to be met. values:\\ntrue - This path is the default fallback.\\nfalse - This path requires filter conditions to be met." |
filter_conditions | JSON | Required within parent | Represents the conditions that must be satisfied for this decision path to be taken. For the default fallback path, this value may be null. For all other paths, the object must include a pattern and criteria_groupings. |
filter_conditions (anyOf 1) | Model | Alternative | Expand Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern |
filter_conditions (anyOf 2) | null | Alternative | Represents the null variant of filter_conditions, permitted only when the path is the default fallback path. |
id | string or null | Optional | Represents the unique identifier of the decision path, generated by the system and used when referencing or updating the path configuration. Maximum length: 19 Minimum length: 1 |
name | string or null | Optional | Represents the display name of the decision path, used to identify the branch during configuration. Maximum length: 20 |
$ (allOf 1) | JSON | All variants apply | Represents the constraint block that requires filter_conditions to be a valid object for all non-default decision paths. |
Referenced models: Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern
Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the filter conditions that determine whether a decision path is taken. Contains a logical pattern and a list of criteria groupings that must be evaluated. Additional keys: not allowed |
criteria_groupings | array or null | Optional | Represents the list of conditions evaluated as part of the decision state. Each grouping defines one logical condition, and its position is referenced by the pattern field. Maximum items: 5 |
criteria_groupings[] | Model | Each item | Expand Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern criteria groupings item |
pattern | string or null | Optional | Represents the logical expression that combines multiple criteria groupings. Each number references a criteria grouping's sequence number, and logical operators such as **and** and **or** determine how conditions are combined. For example, (1and2) requires both grouping 1 and grouping 2 to be satisfied. Maximum length: 100 Minimum length: 1 |
Referenced models: Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern criteria groupings item
Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern criteria groupings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single condition grouping evaluated as part of a kiosk decision state. Defines the data source type, evaluation value, and optional criteria details for one logical condition. Additional keys: not allowed |
criteria | Model | Optional | Expand Related Records — request body — query filters The actual comparison logic for this criteria grouping. Supports both simple field-value comparisons (via SimpleFilterCriterionRequest) and nested grouped conditions (via GroupedFilterCriterionRequest). Defined in Criterion.json. Note: The only possible types for the 'value' will be 'value' and 'field' (If you want to compare with any field in the Kiosk itself, you should send the type as 'field' and the format will be <kiosk_api_name>.<screen_field_api_name> in case referring to Kiosk's screen field. Example: 'criteria': {'field': { 'api_name': 'Screen_2_Single_Line_2', 'id': '2296900000013105115', 'field_label': 'Single Line 2', 'data_type': 'text'}, 'comparator': 'equal', 'value': { 'api_name': 'Bug2.Screen_2_Single_Line_2', 'id': '2296900000013105115' },'type': 'field' }. If the type is just 'value', then a simple string is used for comparison. Strictly follow this pattern for Kiosk's criteria overriding any discrepancies in Criterion.json. |
resource | Model | Optional | Expand Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern criteria groupings item resource The resource object identifies the specific data resource that should be used when evaluating the condition. This object is primarily used when the condition type refers to external data sources such as records retrieved using a GetRecord configuration or records created earlier in the kiosk execution. The resource object ensures that the decision condition references the correct record source. |
sequence_number | integer or null | Required within parent | The source for the criteria evaluation . Possible values: current_record - Criteria evaluated against the current record. get_record - Criteria evaluated based on whether the Get Records response contains data or not. kiosk_fields - Criteria evaluated against the screen fields or action fields from Kiosk. loop_record - Evaluates a field from a loop record. Format: int32 |
type | string | Required within parent | Represents the data source used for condition evaluation. Possible values:current_record - Evaluates a field from the current CRM record. Possible values: get_record - Evaluates a field from a get_record result. kiosk_fields - Evaluates a kiosk screen field. data_hub - Evaluates a data hub field. created_record - Evaluates a field from a record created earlier in the kiosk. loop_record - Evaluates a field from a loop record. One of: current_record, get_record, kiosk_fields, data_hub, created_record, loop_record |
value | string | Required within parent | Indicates whether the evaluated field must contain data. Possible values: ${NOTEMPTY} - The field must have a value. ${EMPTY} - The field must be empty. One of: ${EMPTY}, ${NOTEMPTY} |
Referenced models: Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern criteria groupings item resource, Related Records — request body — query filters
Kiosk State — request body — body states item details path details path details item filter conditions criteria groupings, pattern criteria groupings item resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the data resource used when evaluating a decision condition. Contains the identifier and name of the get_record or created-record configuration referenced by the condition. Additional keys: not allowed |
id | string or null | Optional | Represents the unique identifier of the resource — a get_record or created-record configuration — used when evaluating the decision condition. Maximum length: 19 Minimum length: 1 |
name | string or null | Optional | Represents the display name of the referenced resource used in the decision condition. Maximum length: 20 Minimum length: 1 |
Kiosk State — request body — body states item details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for updating a kiosk screen state. Contains the screen_details object with the UI elements, buttons, and layout properties to be updated. Additional keys: not allowed |
screen_details | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details Configuration object defining the UI screen that will be rendered to the kiosk user. This object contains all information required to dynamically construct the screen interface including: input elements, interactive components, layout configuration, action buttons, screen metadata The kiosk runtime uses this configuration to generate the UI dynamically without requiring frontend code changes. Elements key is mandatory for a screen_details JSON while creating screen state. |
Referenced models: Kiosk State — request body — body states item details screen details screen details
Kiosk State — request body — body states item details screen details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the UI screen configuration used when updating a kiosk screen state. Contains the elements, buttons, width, title, and button alignment. Additional keys: not allowed |
button_align | string or null | Optional | Represents the alignment direction of action buttons within the screen footer.\nPossible values:\nleft_to_right - Buttons appear in natural reading order.\nright_to_left - Buttons appear aligned from right. One of: right_to_left, left_to_right, center |
buttons | array or null | Optional | Represents the list of action buttons on the screen. Each button triggers a transition to another state. When provided, each button must include a prop_name and name. Maximum items: 1 |
buttons[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details buttons item |
elements | array or null | Optional | Represents the list of UI components rendered on the screen, ordered from top to bottom. Supported element types include field, screen_field, text, get_records, zia_insights, and data_hubs. Maximum items: 30 |
elements[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details elements item |
title | string or null | Optional | Represents the display title shown at the top of the kiosk screen, providing contextual information about the screen's purpose. Maximum length: 255 |
width | string or null | Optional | Represents the visual width of the screen container. Possible values: 670px - Standard width layout. 1000px - Wide layout. If provided, must be one of: 670px, 1000px. Maximum length: 50 Pattern: ^(670px|1000px)$ |
Referenced models: Kiosk State — request body — body states item details screen details screen details buttons item, Kiosk State — request body — body states item details screen details screen details elements item
Kiosk State — request body — body states item details screen details screen details buttons item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a screen button that triggers a transition to another state. Each button has a display name and a style type. Additional keys: not allowed |
name | string | Required within parent | Specify the display label of the button shown to the user. Maximum length: 255 |
prop_name | string | Required within parent | Represents the style type of the button. 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. One of: outlineprimary, primary, default, failure, outlineredlight |
Kiosk State — request body — body states item details screen details screen details elements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single UI component rendered on the screen during an update operation. The type field determines the element's structure and the required configuration object. Additional keys: not allowed |
data_hub | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item data hub Represents an integration with a data hub query or lookup system. This allows the screen to fetch and display data from external sources. |
field | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item field Configuration object describing a form input field that users can interact with on the screen. This object defines: field label data type validation rules UI presentation API mapping The kiosk runtime uses this configuration to render the correct input component and collect user input. |
get_record | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item get record Reference to a record retrieval operation called a get_record. This component fetches records from the CRM system and displays them within the screen. The records are fetched by using user-specified criteria. This should be given if a get_record component created anywhere else in the Kiosk is to be associated in the current screen. |
name | string or null | Optional | Represents the display name of the screen element. Maximum length: 255 |
open_record | boolean or null | Optional | Indicates whether clicking a record in the get_record component opens its detail view.\nPossible values:\ntrue - Clicking a record opens its detail view.\nfalse - Records are displayed without navigating to the detail view. |
selected_fields | array or null | Optional | Represents the list of fields to retrieve from the get_record component and display on the screen. Maximum items: 50 |
selected_fields[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details elements item selected fields item |
type | string or null | Optional | Represents the type of the screen element, which determines which UI component is rendered. Supported types include field, screen_field, get_records, text, zia_insights, data_hubs, and created_records. One of: screen_field, field, get_records, text, zia_insights, data_hubs, created_records |
ui_type | integer or null | Optional | Represents the numeric identifier of the UI component type used by the rendering engine to determine which widget to display. Format: int32 |
value | JSON | Optional | Represents the content of the element for text-type elements. Null for other element types such as field, screen_field, and get_records. |
value (anyOf 1) | string | Alternative | Represents the string content value for text-type screen elements. Maximum length: 2000 |
value (anyOf 2) | boolean | Alternative | Represents the Boolean predefined value for checkbox-type screen fields. |
value (anyOf 3) | null | Alternative | Represents the null value for screen elements that do not have a predefined value. |
zia_insight | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item zia insight Represents an AI-powered insight component. This widget can display predictions, recommendations, or analytics generated by the Zia AI engine. |
$ (allOf 1) | JSON | All variants apply | Represents the conditional schema constraint that requires the field object when the element type is field. |
$ (allOf 2) | JSON | All variants apply | Represents the conditional schema constraint that requires selected_fields when the element type is get_records. |
$ (allOf 3) | JSON | All variants apply | Represents the conditional schema constraint that requires the get_record object when the element type is get_records. |
$ (allOf 4) | JSON | All variants apply | Represents the conditional schema constraint that requires the data_hub object when the element type is data_hubs. |
$ (allOf 5) | JSON | All variants apply | Represents the conditional schema constraint that requires the zia_insight object when the element type is zia_insights. |
Referenced models: Kiosk State — request body — body states item details screen details screen details elements item data hub, Kiosk State — request body — body states item details screen details screen details elements item field, Kiosk State — request body — body states item details screen details screen details elements item get record, Kiosk State — request body — body states item details screen details screen details elements item selected fields item, Kiosk State — request body — body states item details screen details screen details elements item zia insight
Kiosk State — request body — body states item details screen details screen details elements item data hub
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a data hub component configuration on a kiosk screen. Defines the API name, identifier, data type, and rendering properties for the data hub element. Additional keys: not allowed |
api_name | string or null | Optional | Represents the unique API name of the data hub component to be associated with the screen. Maximum length: 255 |
data_type | string or null | Optional | Represents the data type of the data hub component. Maximum length: 255 |
field_label | string or null | Optional | Represents the display label shown on the screen for the data hub component during execution and preview. Maximum length: 255 |
id | string or null | Optional | Represents the unique identifier of the data hub component to be associated with the screen. Maximum length: 19 |
read_only | boolean or null | Optional | Indicates whether the data hub component is read-only. Possible values: true - The component is displayed but cannot be edited. false - The user can interact with the component. |
required | boolean or null | Optional | Indicates whether the data hub component is mandatory during kiosk execution. Possible values: true - A value must be provided. false - The component may be skipped. |
ui_type | integer or null | Optional | Represents the numeric identifier of the UI widget type used to render the data hub component. Format: int32 |
Kiosk State — request body — body states item details screen details screen details elements item field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the form input field configuration for updating a kiosk screen. Defines the field label, data type, API name, UI type, validation rules, and additional type-specific properties. Additional keys: not allowed |
_merge_field | string or null | Optional | Represents a dynamic data binding expression that populates the field from an external source. Three formats are supported: record field reference, CRM module field reference, and kiosk screen field reference. Maximum length: 500 |
_pick_list_type | string or null | Optional | Represents the source of picklist values. Possible values: local - Values are defined inline within the screen field. global_set - Values are sourced from a shared global picklist. Maximum length: 255 |
allow_multiple_upload | boolean or null | Optional | Indicates whether multiple file uploads are allowed for the field. Possible values: true - Multiple file uploads are allowed. false - Only a single file upload is allowed. |
api_name | string or null | Optional | Represents the unique API name used to map the field to backend data structures, workflow variables, and subsequent kiosk states. Maximum length: 50 |
currency | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item field currency It defines the currency field's properties. Says how the value should be saved based on decimal places, precision, and rounding option. |
data_type | string or null | Optional | Represents the data format expected for the field, controlling both frontend input validation and backend data interpretation. One of: text, fileupload, userlookup, multiselectpicklist, picklist, datetime, date, email, boolean, currency, integer, phone, textarea, multichoicelookup, lookup, website, percent, double |
decimal_place | integer or null | Optional | Represents the number of digits after the decimal point for numeric fields. For currency fields, this value must be greater than the precision value in the currency configuration. Format: int32 |
field_label | string or null | Optional | Represents the display label shown to the user for the input field. This label is visible on the screen but does not affect backend storage. Maximum length: 255 Pattern: [0-9a-zA-Z_\\-\\.\\|\\$\\&@\\(\\)\\?\\,\\'\\/\\!\\P{InBasicLatin}\\s]+ |
global_picklist | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item field global picklist Reference to a globally defined picklist. |
length | integer or null | Optional | Represents the maximum number of characters or digits allowed for the field. Format: int32 |
number_separator | boolean or null | Optional | Indicates whether a thousands separator is displayed for values in this field. Possible values: true - A thousands separator is displayed. false - No thousands separator is displayed. |
pick_list_values | array or null | Optional | Represents the list of options available for selection in a picklist field. Maximum items: 1000 |
pick_list_values[] | Model | Each item | Expand Kiosk State — request body — body states item details screen details screen details elements item field pick list values item |
read_only | boolean or null | Optional | Indicates whether the field is read-only. Possible values: true - The field is displayed but cannot be edited. false - The user can input or modify the value. |
required | boolean or null | Optional | Indicates whether a value is required before the screen can proceed. Possible values: true - A value must be provided. false - The field may be left empty. |
tooltip | Model | Optional | Expand Kiosk State — request body — body states item details screen details screen details elements item field tooltip Defines additional help information associated with the field. Tooltips provide contextual guidance to users explaining what data should be entered. |
ui_type | integer or null | Optional | Represents the numeric identifier of the UI widget type, used by the rendering engine to determine which component to display. Format: int32 |
value | boolean or null | Optional | Represents a predefined value for the field. For checkbox fields, this is true when the checkbox is checked by default and false when unchecked. |
$ (allOf 1) | JSON | All variants apply | Represents the conditional schema constraint that requires the decimal_place field when the data type is double. |
$ (allOf 2) | JSON | All variants apply | Represents the conditional schema constraint that requires the currency object when the data type is currency. |
$ (allOf 3) | JSON | All variants apply | Represents the conditional schema constraint that requires pick_list_values when the data type is multiselectpicklist. |
$ (allOf 4) | JSON | All variants apply | Represents the conditional schema constraint that requires pick_list_values when the data type is picklist. |
$ (allOf 5) | JSON | All variants apply | Represents the conditional schema constraint that requires _pick_list_type when the data type is multiselectpicklist. |
$ (allOf 6) | JSON | All variants apply | Represents the conditional schema constraint that requires _pick_list_type when the data type is picklist. |
$ (allOf 7) | JSON | All variants apply | Represents the conditional schema constraint that requires allow_multiple_upload when the data type is fileupload. |
Referenced models: Kiosk State — request body — body states item details screen details screen details elements item field currency, Kiosk State — request body — body states item details screen details screen details elements item field global picklist, Kiosk State — request body — body states item details screen details screen details elements item field pick list values item, Kiosk State — request body — body states item details screen details screen details elements item field tooltip
Kiosk State — request body — body states item details screen details screen details elements item field currency
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the currency field configuration, including the rounding option and precision for storing currency values. Additional keys: not allowed |
precision | integer or null | Optional | Represents the number of digits displayed after the decimal point for the currency field value. Format: int32 |
rounding_option | string or null | Optional | Specify the rounding method to apply to the currency value. The default value is Normal. Possible values: normal - Truncates the value to the configured number of decimal places without rounding. round_off - Rounds the value to the configured number of decimal places using standard rounding rules. round_up - Always rounds the value up to the configured number of decimal places. round_down - Always rounds the value down to the configured number of decimal places. One of: normal, round_off, round_up, round_down |
$ (allOf 1) | JSON | All variants apply | Represents the conditional schema constraint that requires the precision field when the rounding_option is round_off. |
$ (allOf 2) | JSON | All variants apply | Represents the conditional schema constraint that requires the precision field when the rounding_option is round_up. |
$ (allOf 3) | JSON | All variants apply | Represents the conditional schema constraint that requires the precision field when the rounding_option is round_down. |
Kiosk State — request body — body states item details screen details screen details elements item field global picklist
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to a globally defined picklist. Contains the API name and unique identifier of the shared global picklist resource. Additional keys: not allowed |
api_name | string or null | Optional | Represents the API name of the shared global picklist. Maximum length: 255 |
id | string or null | Optional | Represents the unique identifier of the global picklist resource. Maximum length: 19 |
Kiosk State — request body — body states item details screen details screen details elements item field pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single selectable option in a picklist field. Contains the display value shown to the user and the actual value stored internally. Additional keys: not allowed |
actual_value | string or null | Optional | Represents the value stored internally when this picklist option is selected. Maximum length: 255 |
display_value | string or null | Optional | Represents the text displayed to the user for this picklist option. Maximum length: 255 |
Kiosk State — request body — body states item details screen details screen details elements item field tooltip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the tooltip configuration for updating a screen field. Contains the tooltip type and the text displayed to the user. Additional keys: not allowed |
name | string or null | Optional | Represents the type of tooltip presentation for the field. Possible values: info_icon - Displays an information icon next to the field. static_text - Displays informational text next to the field. One of: info_icon, static_text |
value | string or null | Optional | Represents the text displayed inside the tooltip for the field. Maximum length: 500 |
Kiosk State — request body — body states item details screen details screen details elements item get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to a get_record component configured elsewhere in the kiosk. Contains the ID and display name of the get_record component to be associated with the screen. Additional keys: not allowed |
id | string or null | Optional | Represents the unique identifier of the get_record component to be associated with the screen. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the get_record component to be associated with the screen. Maximum length: 255 |
Kiosk State — request body — body states item details screen details screen details elements item selected fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field selected from a get_record component to retrieve and display on the screen. Contains the field's API name and unique identifier. Additional keys: not allowed |
api_name | string or null | Optional | Represents the API name of the field selected from the record to display on the screen. Maximum length: 250 |
id | string or null | Optional | Represents the unique identifier of the field selected from the record to display on the screen. Maximum length: 19 |
Kiosk State — request body — body states item details screen details screen details elements item zia insight
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the Zia AI insight component configuration for a kiosk screen. Defines the API name, field label, component type, required flag, read-only flag, and the parent record used as input. Additional keys: not allowed |
api_name | string or null | Optional | Represents the unique API name of the Zia insight component to be associated with the screen. Maximum length: 255 |
component_name | string | Required within parent | Represents the specific type of Zia AI insight component, such as prediction or recommendation. One of: best_time_to_contact, prediction, churn_prediction, similarity, recommendation_early_access, Competitors_Alert, zia_score, next_best_action, voc_primary |
field_label | string or null | Optional | Represents the display label shown on the screen for the Zia insight component during execution and preview. Maximum length: 255 |
parent_record_field | Model | Required within parent | Expand Kiosk State — request body — body states item details screen details screen details elements item zia insight parent record field Defines the record used as input for generating the AI insight. (Required) |
read_only | boolean or null | Optional | Indicates whether the Zia insight component is read-only. Possible values: true - The component is displayed but cannot be edited. false - The user can interact with the component. |
required | boolean or null | Optional | Indicates whether the Zia insight component is mandatory during kiosk execution.\nPossible values:\ntrue - A value must be provided.\nfalse - The component may be skipped. |
Referenced models: Kiosk State — request body — body states item details screen details screen details elements item zia insight parent record field