Zoho: Kiosk Get Record — kiosks Get Records update Kiosk Get Record
Zoho kiosksGetRecords.updateKioskGetRecord: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.updatekioskgetrecord
Provider route: PUT /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"]["updateKioskGetRecord"]>[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.updateKioskGetRecord(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.update_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 |
body | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body |
Referenced models: Kiosk Get Record — kiosks Get Records update Kiosk Get Record — 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 Kiosk Get Record — kiosks Get Records update Kiosk Get Record — response body |
Referenced models: Kiosk Get Record — kiosks Get Records update Kiosk Get Record — response body
Schemas
Section titled “Schemas”16 more schemas are linked from the tables above, on the schema pages.
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully updating 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 update Kiosk Get Record — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for updating an existing get_record component. Additional keys: not allowed |
get_records | array | Required within parent | Array containing the get_record update payload. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item |
Referenced models: Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — 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 Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload for updating a get_record component. All fields are optional - only fields provided will be updated. Additional keys: not allowed |
child_relationship | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship Reference to the child relationship. |
criteria | Model | Optional | Expand Related Records — request body — query filters Filter criteria configuration for selecting records. |
module | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module Module from which records will be fetched. |
name | string or null | Optional | Human-readable name of the get_record component. Maximum length: 50 |
parent_record_field | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item parent record field Reference to the parent module field. |
selected_fields | array or null | Optional | Fields to display when the get_record is shown on a screen. Maximum items: 50 |
selected_fields[] | string | Each item | API name of a selected field. Maximum length: 30 |
selection_details | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item selection details Selection rules controlling how many records are fetched. |
sort_order | Model | Optional | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order Sorting configuration for the fetched records. |
type | string or null | Optional | Module type: 'parent' or 'child'. One of: parent, child |
Referenced models: Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship, Related Records — request body — query filters, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item parent record field, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item selection details, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order
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 |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Child relationship reference for update operations. Additional keys: not allowed |
display_label | string or null | Optional | Display label of the child relationship. Maximum length: 50 |
id | string or null | Optional | Unique identifier of the child relationship. Maximum length: 19 |
Related Records — request body — query filters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators. |
$ (anyOf 1) | Model | Alternative | Expand Related Records — request body — query filters value |
$ (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or |
Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module reference for update operations. All fields are optional. Additional keys: not allowed |
api_name | string or null | Optional | API name of the module. Maximum length: 50 |
id | string or null | Optional | Unique identifier of the module. Maximum length: 19 |
name | string or null | Optional | Display name of the module. Maximum length: 50 |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item parent record field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Parent record field reference for update operations. Additional keys: not allowed |
id | string or null | Optional | Unique identifier of the parent record field. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selection rules for update operations. All fields are optional. Additional keys: not allowed |
limit | integer or null | Optional | Maximum number of records the user can select. Format: int32 |
range | integer or null | Optional | Maximum number of records to fetch. Format: int32 |
result_type | string or null | Optional | Determines how many records are fetched. One of: single, multiple, all |
selection_type | string or null | Optional | User selection behavior. One of: mandate, optional, read_only |
$ (allOf 1) | JSON | All variants apply | |
$ (allOf 2) | JSON | All variants apply |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field reference used for ordering fetched records. Additional keys: not allowed |
api_name | string or null | Optional | API name of the sorting field. Maximum length: 50 |
display_label | string or null | Optional | Display label of the sorting field. Maximum length: 255 |
id | string or null | Optional | Unique identifier of the sorting field. Maximum length: 19 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.updatekioskgetrecord. Catalog operation: updateKioskGetRecord. 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.