Skip to content

Zoho: Update a Kiosk

Zoho kiosks.updateKiosk: arguments, response, policy and SDK examples.

← Kiosks operations · Get started

Operation zoho.updatekiosk

Provider route: PUT /crm/v8/settings/kiosks/{kioskId}. 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["kiosks"]["updateKiosk"]>[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.kiosks.updateKiosk(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.update_kiosk(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: 19
bodyModelOptionalExpand Update a Kiosk — request body — body

Referenced models: Update a Kiosk — 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 Update a Kiosk — response body

Referenced models: Update a Kiosk — response body

Update a Kiosk — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the alternate top-level request payload for updating a kiosk, containing a kiosks array with one object.
Additional keys: not allowed
kiosksarrayRequired within parentContains the details of the kiosk to be updated. Although the field is an array, only one kiosk can be updated per request.
Maximum items: 1
kiosks[]ModelEach itemExpand Update a Kiosk — request body — body kiosks item

Referenced models: Update a Kiosk — request body — body kiosks item

Update a Kiosk — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned after updating a kiosk, containing an array of per-item operation results.
Additional keys: not allowed
kiosksarrayOptionalContains the list of kiosk result objects from the update operation.
Maximum items: 1
kiosks[]ModelEach itemExpand Update a Kiosk — response body — kiosks item

Referenced models: Update a Kiosk — response body — kiosks item

Update a Kiosk — request body — body kiosks item
FieldTypePresenceDescription and constraints
$objectRootRepresents the alternate schema for updating a kiosk, supporting name, description, read-only identifier, and current record module.
Additional keys: not allowed
current_record_moduleModelOptionalExpand Update a Kiosk — request body — body kiosks item current record module
It is a json object which will contain the details of the current record module being set for the Kiosk. Current record is a designated module from which a specific record will be used for actions inside the Kiosk. For example, if the current record is set as Leads. While running actions or associating a field with current record, the user may have to provide a Lead id during execution. The action/association will be done based on this particular Lead. Current record can be set either in POST or PUT call of kiosks.
descriptionstring or nullOptionalSpecifies the description of the kiosk. The description can indicate the purpose of the kiosk and can be left empty during an update.
Maximum length: 500
group_api_namestring or nullOptionalSpecifies the API name of the kiosk group. The group API name can be at most 25 characters in length.
Maximum length: 25
idstring or nullOptionalSpecifies the unique identifier of the kiosk to be updated. This field is read-only; any changes to this value are not applied.
Maximum length: 19
Read only: true
namestring or nullOptionalSpecifies the name of the kiosk. The kiosk name can be at most 25 characters in length.
Maximum length: 25

Referenced models: Update a Kiosk — request body — body kiosks item current record module

Update a Kiosk — response body — kiosks item
FieldTypePresenceDescription and constraints
$objectRootRepresents the per-item result of a kiosk update operation, including the status code, message, status, and identifier of the updated kiosk.
Additional keys: not allowed
codestringOptionalRepresents the result code of the kiosk update operation.
Maximum length: 255
detailsModelOptionalExpand Update a Kiosk — response body — kiosks item details
messagestringOptionalRepresents the message describing the outcome of the kiosk update operation.
Maximum length: 255
statusstringOptionalIndicates the result status of the kiosk update operation.
Maximum length: 255

Referenced models: Update a Kiosk — response body — kiosks item details

Update a Kiosk — request body — body kiosks item current record module
FieldTypePresenceDescription and constraints
$objectRootRepresents the alternate input schema for specifying the current record module when updating a kiosk. When both identifier and api_name are provided, they must reference the same module.
Additional keys: not allowed
api_namestring or nullOptionalSpecifies the API name of the module to set as the current record. When both identifier and api_name are provided, they must point to the same module.
Maximum length: 250
idstring or nullOptionalSpecifies the unique identifier of the module to set as the current record. Each module has a unique identifier in Zoho CRM.
Maximum length: 18
Update a Kiosk — response body — kiosks item details
FieldTypePresenceDescription and constraints
$objectRootRepresents the identifier of the updated kiosk returned as part of the update operation result.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the updated kiosk.
Maximum length: 255

SDK function policy ID: zoho.updatekiosk. Catalog operation: updateKiosk. 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.