Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.kioskIdstringRequired within parentMaximum length: 255
bodyModelRequired within parentExpand Create a kiosk state — request body — body

Referenced models: Create a kiosk state — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a kiosk state — response body

Referenced models: Create a kiosk state — response body

78 more schemas are linked from the tables above, on the schema pages.

Create a kiosk state — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
statesarrayRequired within parentRepresents the array containing exactly one state object to create.
Maximum items: 1
states[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents the success response returned after a kiosk state creation.
Additional keys: not allowed
statesarrayOptionalRepresents the array of operation result objects for the created kiosk states.
Maximum items: 1
states[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
detailsJSONRequired within parentRepresents 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)ModelAlternativeExpand Create a kiosk state — request body — body states item details screen details
details (anyOf 2)ModelAlternativeExpand Kiosk State — request body — body states item details path details
details (anyOf 3)ModelAlternativeExpand 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)ModelAlternativeExpand Create a kiosk state — request body — body states item details get record
from_transitionModelRequired within parentExpand Create a kiosk state — request body — body states item from transition
namestringRequired within parentSpecify 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
typestringRequired within parentRepresents 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)JSONAll variants applyRepresents the from_transition property that identifies the transition edge activating the new kiosk state.
$ (allOf 2)JSONAll variants applyRepresents the name property that defines the display name of the new kiosk state.
$ (allOf 3)JSONAll variants applyRepresents the type discriminator property that specifies the state type.
$ (allOf 4)JSONAll variants applyRepresents 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
codestringOptionalRepresents the result code for the operation on this state.
Maximum length: 255
detailsModelOptionalExpand Delete a kiosk state — response body — states details
messagestringOptionalRepresents the result message for the operation on this state.
Maximum length: 255
statusstringOptionalRepresents 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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_detailsarrayRequired within parentRepresents 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[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
idstringRequired within parentRepresents 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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_recordobjectRequired within parentContains 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.idstringRequired within parentRepresents the unique identifier of the get_record configuration.
Maximum length: 255
get_record.namestringRequired within parentRepresents the display name of the get_record configuration.
Maximum length: 255
Create a kiosk state — request body — body states item details screen details
FieldTypePresenceDescription and constraints
$objectRootRepresents 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_detailsModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
idstringOptionalRepresents the unique identifier of the kiosk state created or updated.
Maximum length: 255
ridstringOptionalRepresents the resource identifier of the kiosk state.
Format: uuid
Maximum length: 255

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.

Official provider source

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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