Zoho: Delete a kiosk state
Zoho kiosksStates.deleteKioskState: arguments, response, policy and SDK examples.
← Kiosks states operations · Get started
Operation zoho.deletekioskstate
Provider route: DELETE /crm/v8/settings/kiosks/{kioskId}/states/{stateId}. 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"]["deleteKioskState"]>[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.deleteKioskState(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.delete_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 |
path.stateId | string | Required within parent | Maximum length: 255 |
query | object | Optional | Additional keys: not allowed |
query.delete_dependent_states | string | Optional | One of: true|false |
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 Delete a kiosk state — response body |
Referenced models: Delete a kiosk state — response body
Schemas
Section titled “Schemas”Delete a kiosk state — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response returned after a kiosk state deletion. Additional keys: not allowed |
states | Model | Optional | Expand Delete a kiosk state — response body — states |
Referenced models: Delete a kiosk state — response body — states
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
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.deletekioskstate. Catalog operation: deleteKioskState. 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.