Zoho: Kiosk Associations — kiosks Get Records update Kiosk Associations
Zoho kiosksGetRecords.updateKioskAssociations: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.updatekioskassociations
Provider route: PUT /crm/v8/settings/kiosks/{kioskId}/associations. 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"]["updateKioskAssociations"]>[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.updateKioskAssociations(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_associations(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 |
body | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — 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 Associations — kiosks Get Records update Kiosk Associations — response body |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body
Schemas
Section titled “Schemas”Kiosk Associations — kiosks Get Records update Kiosk Associations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully updating kiosk associations. Additional keys: not allowed |
kiosks | array | Optional | Array of operation results. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for updating kiosk associations. Additional keys: not allowed |
kiosks | array | Required within parent | Array of kiosk association configurations. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item
Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation result for kiosk association operations. Additional keys: not allowed |
code | string | Optional | Result code. 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. 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 — request body — body kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload for configuring kiosk associations. Additional keys: not allowed |
_associations | array | Required within parent | Association configurations. Maximum items: 1 |
_associations[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item |
id | string | Required within parent | ID of the kiosk to associate. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item
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 Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Association configuration specifying association type and target. Additional keys: not allowed |
detail_view_page | array | Required within parent | Detail view page configurations. Maximum items: 1 |
detail_view_page[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item |
type | string | Required within parent | Type of association. One of: detail_view_page Maximum length: 20 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration for associating a kiosk with a detail view page. Additional keys: not allowed |
_delete | string or null | Optional | Set to trigger deletion of this association. Maximum length: 255 |
layout | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item layout Layout to associate the kiosk with. |
module | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module Module for the detail view page association. |
name | string | Required within parent | Display name for the association widget on the detail view page. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item layout, Kiosk Get Record — kiosks Get Records update Kiosk Get Record — request body — body get records item module
Kiosk Associations — kiosks Get Records update Kiosk Associations — request body — body kiosks item associations item detail view page item layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Layout reference. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the layout. Maximum length: 19 |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.updatekioskassociations. Catalog operation: updateKioskAssociations. 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.