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.
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["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 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.create_kiosk(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a Kiosk — request body — body |
Referenced models: Create a Kiosk — 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 Create a Kiosk — response body |
Referenced models: Create a Kiosk — response body
Schemas
Section titled “Schemas”Create a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the top-level request payload for creating a kiosk. Contains a kiosks array, with one kiosk object per request. Additional keys: not allowed |
kiosks | array | Required within parent | Contains 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[] | Model | Each item | Expand Create a Kiosk — request body — body kiosks item |
Referenced models: Create a Kiosk — request body — body kiosks item
Create a Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after creating a kiosk, containing an array of per-item operation results. Additional keys: not allowed |
kiosks | array | Optional | Contains the list of kiosk objects created. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Create a Kiosk — response body — kiosks item |
Referenced models: Create a Kiosk — response body — kiosks item
Create a Kiosk — request body — body kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_module | Model | Optional | Expand 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. |
description | string or null | Optional | Specifies 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_name | string or null | Optional | Specifies 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 |
name | string | Required within parent | Specifies the name of the kiosk. The kiosk name can be at most 25 characters in length. Maximum length: 25 |
status | string | Required within parent | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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 |
code | string | Optional | Represents the result code of the kiosk create operation. Maximum length: 255 |
details | Model | Optional | Expand Create a Kiosk — response body — kiosks item details |
message | string | Optional | Represents the message describing the outcome of the kiosk create operation. Maximum length: 255 |
status | string | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents 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_name | string or null | Optional | Specifies 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 |
id | string or null | Optional | Specifies 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifiers for the created kiosk, such as the kiosk identifier, returned as part of the operation result. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the newly created kiosk. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.