Skip to content

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.

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 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.clone_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
queryobjectOptionalAdditional keys: not allowed
query.delete_kiosk_idstringOptionalMaximum length: 19
query.kiosk_clonestringOptionalMaximum length: 255
bodyModelOptionalExpand Clone a Kiosk — request body — body

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

Referenced models: Clone a Kiosk — response body

Clone a Kiosk — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents the request payload for cloning a kiosk, containing the list of kiosk configurations to be created via cloning.
Additional keys: not allowed
kiosksarrayRequired within parentContains the details for the kiosk to be cloned.
Maximum items: 1
kiosks[]ModelEach itemExpand Clone a Kiosk — request body — body kiosks item

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

Clone a Kiosk — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the response returned when a kiosk clone operation completes successfully, including the status information for the cloned kiosk.
Additional keys: not allowed
kiosksModelOptionalExpand Clone a Kiosk — response body — kiosks

Referenced models: Clone a Kiosk — response body — kiosks

Clone a Kiosk — request body — body kiosks item
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
descriptionstring or nullOptionalSpecifies the description of the kiosk.
Maximum length: 500
group_api_namestring or nullOptionalSpecifies the unique group API name for the kiosk.
Maximum length: 25
namestring or nullOptionalSpecifies the name of the kiosk.
Maximum length: 50
Pattern: [0-9a-zA-Z_\\-\\.\\|\\$\\?\\,\\'\\/\\!\\P{InBasicLatin}\\s]+
typestringRequired within parentSpecifies 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
FieldTypePresenceDescription and constraints
$objectRootRepresents the status of a kiosk clone operation, including the status code, message, and item details.
Additional keys: not allowed
codestringOptionalRepresents the status code of the kiosk clone operation.
Maximum length: 255
detailsModelOptionalExpand Clone a Kiosk — response body — kiosks details
messagestringOptionalRepresents the message describing the outcome of the kiosk clone operation.
Maximum length: 255
statusstringOptionalIndicates 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
FieldTypePresenceDescription and constraints
$objectRootRepresents the identifiers and related details for a cloned kiosk item returned in a clone operation response.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the kiosk.
Maximum length: 255

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.

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.