Skip to content

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.

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 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_get_records.update_kiosk_get_record(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.getRecordIdstringRequired within parentMaximum length: 255
bodyModelRequired within parentExpand 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand 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

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
FieldTypePresenceDescription and constraints
$objectRootResponse after successfully updating a get_record component.
Additional keys: not allowed
get_recordsarrayOptionalArray of operation results.
Maximum items: 1
get_records[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootRequest body for updating an existing get_record component.
Additional keys: not allowed
get_recordsarrayRequired within parentArray containing the get_record update payload.
Maximum items: 1
get_records[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootOperation result for get_record CRUD operations.
Additional keys: not allowed
codestringOptionalResult code (e.g., 'SUCCESS').
Maximum length: 255
detailsModelOptionalExpand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
messagestringOptionalHuman-readable result message.
Maximum length: 255
statusstringOptionalStatus 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
FieldTypePresenceDescription and constraints
$objectRootPayload for updating a get_record component. All fields are optional - only fields provided will be updated.
Additional keys: not allowed
child_relationshipModelOptionalExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item child relationship
Reference to the child relationship.
criteriaModelOptionalExpand Related Records — request body — query filters
Filter criteria configuration for selecting records.
moduleModelOptionalExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
Module from which records will be fetched.
namestring or nullOptionalHuman-readable name of the get_record component.
Maximum length: 50
parent_record_fieldModelOptionalExpand 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_fieldsarray or nullOptionalFields to display when the get_record is shown on a screen.
Maximum items: 50
selected_fields[]stringEach itemAPI name of a selected field.
Maximum length: 30
selection_detailsModelOptionalExpand 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_orderModelOptionalExpand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item sort order
Sorting configuration for the fetched records.
typestring or nullOptionalModule 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
FieldTypePresenceDescription and constraints
$objectRootDetails of the operation result.
Additional keys: not allowed
idstringOptionalID 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
FieldTypePresenceDescription and constraints
$objectRootChild relationship reference for update operations.
Additional keys: not allowed
display_labelstring or nullOptionalDisplay label of the child relationship.
Maximum length: 50
idstring or nullOptionalUnique identifier of the child relationship.
Maximum length: 19
Related Records — request body — query filters
FieldTypePresenceDescription and constraints
$JSONRootRepresents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators.
$ (anyOf 1)ModelAlternativeExpand Related Records — request body — query filters value
$ (anyOf 2)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRootModule reference for update operations. All fields are optional.
Additional keys: not allowed
api_namestring or nullOptionalAPI name of the module.
Maximum length: 50
idstring or nullOptionalUnique identifier of the module.
Maximum length: 19
namestring or nullOptionalDisplay 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
FieldTypePresenceDescription and constraints
$objectRootParent record field reference for update operations.
Additional keys: not allowed
idstring or nullOptionalUnique 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
FieldTypePresenceDescription and constraints
$objectRootSelection rules for update operations. All fields are optional.
Additional keys: not allowed
limitinteger or nullOptionalMaximum number of records the user can select.
Format: int32
rangeinteger or nullOptionalMaximum number of records to fetch.
Format: int32
result_typestring or nullOptionalDetermines how many records are fetched.
One of: single, multiple, all
selection_typestring or nullOptionalUser selection behavior.
One of: mandate, optional, read_only
$ (allOf 1)JSONAll variants apply
$ (allOf 2)JSONAll variants apply
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order order by field
FieldTypePresenceDescription and constraints
$objectRootField reference used for ordering fetched records.
Additional keys: not allowed
api_namestring or nullOptionalAPI name of the sorting field.
Maximum length: 50
display_labelstring or nullOptionalDisplay label of the sorting field.
Maximum length: 255
idstring or nullOptionalUnique identifier of the sorting field.
Maximum length: 19

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.

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.