Zoho: Clone a Kiosk
Zoho kiosks.cloneKiosk: arguments, response, policy and SDK examples.
← Kiosks operations · Get started
Operation zoho.clonekiosk
Provider route: POST /crm/v8/settings/kiosks/{kioskId}/actions/clone. 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"]["cloneKiosk"]>[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.cloneKiosk(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.clone_kiosk(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: 19 |
query | object | Optional | Additional keys: not allowed |
query.delete_kiosk_id | string | Optional | Maximum length: 19 |
query.kiosk_clone | string | Optional | Maximum length: 255 |
body | Model | Optional | Expand Clone a Kiosk — request body — body |
Referenced models: Clone 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 Clone a Kiosk — response body |
Referenced models: Clone a Kiosk — response body
Schemas
Section titled “Schemas”Clone a Kiosk — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for cloning a kiosk, containing the list of kiosk configurations to be created via cloning. Additional keys: not allowed |
kiosks | array | Required within parent | Contains the details for the kiosk to be cloned. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Clone a Kiosk — request body — body kiosks item |
Referenced models: Clone a Kiosk — request body — body kiosks item
Clone a Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when a kiosk clone operation completes successfully, including the status information for the cloned kiosk. Additional keys: not allowed |
kiosks | Model | Optional | Expand Clone a Kiosk — response body — kiosks |
Referenced models: Clone a Kiosk — response body — kiosks
Clone a Kiosk — request body — body kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the attributes for creating a new kiosk from an existing one, including name, description, clone type (dependent or standalone), and group API name. Additional keys: not allowed |
description | string or null | Optional | Specifies the description of the kiosk. Maximum length: 500 |
group_api_name | string or null | Optional | Specifies the unique group API name for the kiosk. Maximum length: 25 |
name | string or null | Optional | Specifies the name of the kiosk. Maximum length: 50 Pattern: [0-9a-zA-Z_\\-\\.\\|\\$\\?\\,\\'\\/\\!\\P{InBasicLatin}\\s]+ |
type | string | Required within parent | Specifies the type of the cloned kiosk. Possible values: dependent - The cloned kiosk depends on the source kiosk. standalone - The cloned kiosk operates independently of the source kiosk. One of: dependent, standalone Maximum length: 20 |
Clone a Kiosk — response body — kiosks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the status of a kiosk clone operation, including the status code, message, and item details. Additional keys: not allowed |
code | string | Optional | Represents the status code of the kiosk clone operation. Maximum length: 255 |
details | Model | Optional | Expand Clone a Kiosk — response body — kiosks details |
message | string | Optional | Represents the message describing the outcome of the kiosk clone operation. Maximum length: 255 |
status | string | Optional | Indicates the result status of the kiosk clone operation. Maximum length: 255 |
Referenced models: Clone a Kiosk — response body — kiosks details
Clone a Kiosk — response body — kiosks details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifiers and related details for a cloned kiosk item returned in a clone operation response. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the kiosk. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.clonekiosk. Catalog operation: cloneKiosk. 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.