Zoho: Kiosk Get Record — kiosks Get Records delete Kiosk Get Record
Zoho kiosksGetRecords.deleteKioskGetRecord: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.deletekioskgetrecord
Provider route: DELETE /crm/v8/settings/kiosks/{kioskId}/get_records/{getRecordId}. 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["kiosksGetRecords"]["deleteKioskGetRecord"]>[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.kiosksGetRecords.deleteKioskGetRecord(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_get_records.delete_kiosk_get_record(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.getRecordId | string | Required within parent | Maximum length: 255 |
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 Kiosk Get Record — kiosks Get Records delete Kiosk Get Record — response body |
Referenced models: Kiosk Get Record — kiosks Get Records delete Kiosk Get Record — response body
Schemas
Section titled “Schemas”Kiosk Get Record — kiosks Get Records delete Kiosk Get Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully deleting a get_record component. Additional keys: not allowed |
get_records | array | Optional | Array of operation results. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation result for get_record CRUD operations. Additional keys: not allowed |
code | string | Optional | Result code (e.g., 'SUCCESS'). Maximum length: 255 |
details | Model | Optional | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details |
message | string | Optional | Human-readable result message. Maximum length: 255 |
status | string | Optional | Status of the operation (e.g., 'success'). Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the operation result. Additional keys: not allowed |
id | string | Optional | ID of the created, updated, or deleted resource. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.deletekioskgetrecord. Catalog operation: deleteKioskGetRecord. 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.