Zoho: Create a kiosk state
Zoho kiosksStates.createKioskState: arguments, response, policy and SDK examples.
← Kiosks states operations · Get started
Operation zoho.createkioskstate
Provider route: POST /crm/v8/settings/kiosks/{kioskId}/states. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["kiosksStates"]["createKioskState"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.kiosksStates.createKioskState(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_zoho import ZohoIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.kiosks_states.create_kiosk_state(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.kioskId | string | Required within parent | Maximum length: 255 |
body | Model | Required within parent | Expand Create a kiosk state — request body — body |
Referenced models: Create a kiosk state — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a kiosk state — response body |
Referenced models: Create a kiosk state — response body
Schemas
Section titled “Schemas”78 more schemas are linked from the tables above, on the schema pages.
Create a kiosk state — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body for creating a kiosk state. The states array contains exactly one state object, and the type field determines which details schema applies. Additional keys: not allowed |
states | array | Required within parent | Represents the array containing exactly one state object to create. Maximum items: 1 |
states[] | Model | Each item | Expand Create a kiosk state — request body — body states item |
Referenced models: Create a kiosk state — request body — body states item
Create a kiosk state — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response returned after a kiosk state creation. Additional keys: not allowed |
states | array | Optional | Represents the array of operation result objects for the created kiosk states. Maximum items: 1 |
states[] | Model | Each item | Expand Delete a kiosk state — response body — states |
Referenced models: Delete a kiosk state — response body — states
Create a kiosk state — request body — body states item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the kiosk state creation payload. The type field determines whether the state is a screen, decision, action, or get_records state, and the corresponding structure of the details object. Additional keys: not allowed |
details | JSON | Required within parent | Represents the state-specific configuration object. The structure varies by the state type: screen uses ScreenCreateDetails, decision uses DecisionCreateDetails, action uses ActionCreateDetails, and get_records uses GetRecordCreateDetails. |
details (anyOf 1) | Model | Alternative | Expand Create a kiosk state — request body — body states item details screen details |
details (anyOf 2) | Model | Alternative | Expand Kiosk State — request body — body states item details path details |
details (anyOf 3) | Model | Alternative | Expand Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks |
details (anyOf 4) | Model | Alternative | Expand Create a kiosk state — request body — body states item details get record |
from_transition | Model | Required within parent | Expand Create a kiosk state — request body — body states item from transition |
name | string | Required within parent | Specify the unique display name of the state. The maximum length is 50 characters, and it must match the regex pattern [0-9a-zA-Z_\-\.\|\$\?\,\'\/\!\P{InBasicLatin}\s]+. Maximum length: 250 |
type | string | Required within parent | Represents the type of the kiosk state. Determines the structure of the details configuration object. Possible values: screen - A visual screen state with form elements. decision - A conditional branching state. action - A CRM operation state. get_records - A record retrieval state. One of: screen, decision, action, get_records |
$ (allOf 1) | JSON | All variants apply | Represents the from_transition property that identifies the transition edge activating the new kiosk state. |
$ (allOf 2) | JSON | All variants apply | Represents the name property that defines the display name of the new kiosk state. |
$ (allOf 3) | JSON | All variants apply | Represents the type discriminator property that specifies the state type. |
$ (allOf 4) | JSON | All variants apply | Represents the details property containing the state-specific configuration object. |
Referenced models: Create a kiosk state — request body — body states item details add meeting, add tags, api name, assign owner, convert, create record, criteria, email notifications, execute for record, field updates, functions, get record, note, open link, open record, quick create record, remove tags, schedule call, tasks, type, webhooks, Kiosk State — request body — body states item details path details, Create a kiosk state — request body — body states item from transition, Create a kiosk state — request body — body states item details get record, Create a kiosk state — request body — body states item details screen details
Delete a kiosk state — response body — states
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the operation result for a single kiosk state in a create or update response. Contains the result code, status, message, and state details. Additional keys: not allowed |
code | string | Optional | Represents the result code for the operation on this state. Maximum length: 255 |
details | Model | Optional | Expand Delete a kiosk state — response body — states details |
message | string | Optional | Represents the result message for the operation on this state. Maximum length: 255 |
status | string | Optional | Represents the result status for the operation on this state. Maximum length: 255 |
Referenced models: Delete a kiosk state — response body — states details
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
Create a kiosk state — request body — body states item from transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the transition trigger that activates a kiosk state. Contains the unique identifier of the transition edge that leads into the state. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the transition that activates this kiosk state. Transitions arise when a button activates on a previous screen, a decision node produces a routing path, or an action completes and triggers the next step. To get details about transitions, refer to the [Get Kiosk States API.](kiosks_states.yaml#$.paths./settings/kiosks/{kioskId}/states.get) Maximum length: 19 |
Create a kiosk state — request body — body states item details get record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for a kiosk get_records state. Contains the reference to the get_record component that defines which records to retrieve. Additional keys: not allowed |
get_record | object | Required within parent | Contains the reference information for the records to be retrieved. Refer to the [Kiosk Get Records API](kiosks_get_records.yaml#$.paths./settings/kiosks/{kioskId}/get_records.get)for details about the get_records element. To create a get_records element that defines how records are fetched from a module, including the criteria, selection behavior, and sorting, refer to the [Create Kiosk Get Records API](kiosks_get_records.yaml#$.paths./settings/kiosks/{kioskId}/get_records.post). Additional keys: not allowed |
get_record.id | string | Required within parent | Represents the unique identifier of the get_record configuration. Maximum length: 255 |
get_record.name | string | Required within parent | Represents the display name of the get_record configuration. Maximum length: 255 |
Create a kiosk state — request body — body states item details screen details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details configuration object for creating a kiosk screen state. Contains the screen_details object, which must include the elements array. Additional keys: not allowed |
screen_details | Model | Required within parent | Expand Create a kiosk state — request body — body states item details screen details screen details Configuration object for the UI screen. Specify the details related to the screen state. The screen state can contain buttons, fields, and components. |
Referenced models: Create a kiosk state — request body — body states item details screen details screen details
Delete a kiosk state — response body — states details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details of a state operation result. Contains the unique identifier and resource identifier of the created or updated kiosk state. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk state created or updated. Maximum length: 255 |
rid | string | Optional | Represents the resource identifier of the kiosk state. Format: uuid Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.createkioskstate. Catalog operation: createKioskState. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.