Skip to content

Zoho: Create a Kiosk

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

← Kiosks operations · Get started

Operation zoho.createkiosk

Provider route: POST /crm/v8/settings/kiosks. 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"]["createKiosk"]>[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.createKiosk(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.create_kiosk(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create a Kiosk — request body — body

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

Referenced models: Create a Kiosk — response body

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

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

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

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

Create a Kiosk — request body — body kiosks item
FieldTypePresenceDescription and constraints
$objectRootRepresents the attributes required to create a kiosk, including name, optional description, unique group API name, status, and optional current record module.
Additional keys: not allowed
current_record_moduleModelOptionalExpand Create 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.
descriptionstring or nullOptionalSpecifies the description for the kiosk. The description can indicate the purpose of the kiosk and can be left empty during creation.
Maximum length: 500
group_api_namestring or nullOptionalSpecifies the unique group API name for the kiosk. The group API name should be similar to the kiosk name. Special characters are not allowed.
Maximum length: 25
namestringRequired within parentSpecifies the name of the kiosk. The kiosk name can be at most 25 characters in length.
Maximum length: 25
statusstringRequired within parentSpecifies the status of the kiosk. Upon successful creation, the initial status of the kiosk is always draft. Possible values:
draft - The kiosk is in draft state upon creation.
Maximum length: 5

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

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

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

Create a Kiosk — request body — body kiosks item current record module
FieldTypePresenceDescription and constraints
$objectRootRepresents the input schema for specifying the current record module when creating 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. For example, provide the module ID for Leads.
Maximum length: 19
Create a Kiosk — response body — kiosks item details
FieldTypePresenceDescription and constraints
$objectRootRepresents the identifiers for the created kiosk, such as the kiosk identifier, returned as part of the operation result.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the newly created kiosk.
Maximum length: 255

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