Zoho: Update a Kiosk Execution
Zoho kiosksExecute.executeKioskState: arguments, response, policy and SDK examples.
← Kiosks execute operations · Get started
Operation zoho.executekioskstate
Provider route: PUT /crm/v8/settings/kiosks/{kioskId}/executions/{executionId}/actions/execute. 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["kiosksExecute"]["executeKioskState"]>[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.kiosksExecute.executeKioskState(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_execute.execute_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: 19 |
path.executionId | string | Required within parent | Maximum length: 19 |
body | Model | Optional | Expand Update a Kiosk Execution — request body — body |
Referenced models: Update a Kiosk Execution — 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 Update a Kiosk Execution — response body |
Referenced models: Update a Kiosk Execution — response body
Schemas
Section titled “Schemas”Update a Kiosk Execution — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for advancing a kiosk execution state, containing one or more execution action entries. Additional keys: not allowed |
kiosk_executions | array | Required within parent | Contains one or more execution action entries, each specifying the transition and data context for advancing the kiosk execution to the next state. Maximum items: 1 |
kiosk_executions[] | Model | Each item | Expand Update a Kiosk Execution — request body — body kiosk executions item |
Referenced models: Update a Kiosk Execution — request body — body kiosk executions item
Update a Kiosk Execution — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates that an execution action completed successfully and provides details of the next executable state and execution ID. Additional keys: not allowed |
kiosk_executions | array | Optional | Contains the result of the execution action, including the status, message, and details of the next executable state. Maximum items: 1 |
kiosk_executions[] | Model | Each item | Expand Update a Kiosk Execution — response body — kiosk executions item |
Referenced models: Update a Kiosk Execution — response body — kiosk executions item
Update a Kiosk Execution — request body — body kiosk executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an action entry for progressing a kiosk execution, providing the data context and transition information. Additional keys: not allowed |
data | Model | Optional | Expand Execute a Kiosk — request body — body kiosk execute item data Contains information about the current execution |
transition | Model | Required within parent | Expand Update a Kiosk Execution — request body — body kiosk executions item transition Contains the transition information for next execution (Required) |
Referenced models: Execute a Kiosk — request body — body kiosk execute item data, Update a Kiosk Execution — request body — body kiosk executions item transition
Update a Kiosk Execution — response body — kiosk executions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of an execution action, including the status code, message, and details of the next executable state. Additional keys: not allowed |
code | string | Optional | Represents the status code returned for the execution action result. Maximum length: 255 |
details | Model | Optional | Expand Execute a Kiosk — response body — kiosk execute item details |
message | string | Optional | Contains the message describing the outcome of the execution action. Maximum length: 255 |
status | string | Optional | Indicates the overall status of the execution action result. Maximum length: 255 |
Referenced models: Execute a Kiosk — response body — kiosk execute item details
Execute a Kiosk — request body — body kiosk execute item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the execution data container, holding the current record reference and the execution instance ID. Additional keys: not allowed |
Current_Record | Model | Optional | Expand Execute a Kiosk — request body — body kiosk execute item data Current Record The Current_Record field provides the record context for the Kiosk execution. |
id | string or null | Optional | Represents the unique identifier of the kiosk execution instance. Maximum length: 18 |
Referenced models: Execute a Kiosk — request body — body kiosk execute item data Current Record
Update a Kiosk Execution — request body — body kiosk executions item transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents transition input providing the transition name and required ID for kiosk execution progression. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the transition that triggers the current execution step. Maximum length: 19 |
name | string or null | Optional | Represents the display name of the transition that triggers the current execution step. Maximum length: 50 |
Execute a Kiosk — response body — kiosk execute item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides details of a test run execution, including the next executable state, any dependent states that were executed, and the execution record ID. Additional keys: not allowed |
executed_dependent_states | JSON | Optional | |
executed_dependent_states (anyOf 1) | array | Alternative | Contains the list of dependent states that were executed as part of the test run, or null if no dependent states were triggered. Maximum items: 10 |
executed_dependent_states (anyOf 1)[] | Model | Each item | Expand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item |
executed_dependent_states (anyOf 2) | null | Alternative | Contains the list of dependent states that were executed as part of the test run, or null if no dependent states were triggered. Maximum items: 10 |
executed_dependent_states (anyOf 2)[] | Model | Each item | Expand Execute a Kiosk — response body — kiosk execute item details executed dependent states null item |
id | string | Optional | Contains the unique identifier of the test run execution record. Maximum length: 255 |
next_executable_state | Model | Optional | Expand Execute a Kiosk — response body — kiosk execute item details next executable state |
Referenced models: Execute a Kiosk — response body — kiosk execute item details next executable state, Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
Execute a Kiosk — request body — body kiosk execute item data Current Record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to the current module record used during kiosk execution, including the record ID. Additional keys: not allowed |
id | string or null | Optional | Represents the unique identifier of the current module record referenced during execution. Maximum length: 19 |
Execute a Kiosk — response body — kiosk execute item details next executable state
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An array of dependent states that were executed during the test run. Each object contains information about the state and the transition taken. Additional keys: not allowed |
id | string | Optional | Contains the unique identifier of the next executable kiosk state. Maximum length: 255 |
name | string | Optional | Represents the display name of the next executable kiosk state. Maximum length: 255 |
Execute a Kiosk — response body — kiosk execute item details executed dependent states null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A dependent state executed during kiosk execution Additional keys: not allowed |
details | object | Optional | Field: details — optional state-specific details Additional keys: allowed |
id | string | Required within parent | Field: id Maximum length: 255 |
name | string | Required within parent | Field: name Maximum length: 255 |
rid | string | Optional | Field: rid Format: uuid Maximum length: 255 |
transition | object | Required within parent | Field: transition Additional keys: not allowed |
transition.id | string | Required within parent | Field: id Maximum length: 255 |
transition.name | string | Required within parent | Field: name Maximum length: 255 |
transition.rid | string | Optional | Field: rid Format: uuid Maximum length: 255 |
type | string | Optional | Field: type Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.executekioskstate. Catalog operation: executeKioskState. 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.