Skip to content

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.

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 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.delete_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
path.stateIdstringRequired within parentMaximum length: 255
queryobjectOptionalAdditional keys: not allowed
query.delete_dependent_statesstringOptionalOne of: true|false

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

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

Referenced models: Delete a kiosk state — response body

Delete a kiosk state — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the success response returned after a kiosk state deletion.
Additional keys: not allowed
statesModelOptionalExpand Delete a kiosk state — response body — states

Referenced models: Delete a kiosk state — response body — states

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

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.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.

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.