Zoho: Clone a CRM profile

← Profiles operations · Get started

Operation zoho.cloneprofile

Provider route: POST /crm/v8/settings/profiles/{id}/actions/clone. Alter supplies the connection’s credentials and routing.

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["profiles"]["cloneProfile"]>[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.profiles.cloneProfile(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.profiles.clone_profile(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
body	object	Required within parent	Request body for cloning a profile. Additional keys: not allowed
body.profiles	array	Required within parent	Single-item JSON array containing the new profile definition for the clone operation. Maximum items: 1
body.profiles[]	object	Each item	New profile to create from the cloned source. Additional keys: not allowed
body.profiles[].description	string or null	Optional	A description of the profile. Accepts up to 250 characters. Maximum length: 250
body.profiles[].name	string	Required within parent	The name of the new profile. Accepts up to 50 characters. Maximum length: 50

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 CRM profile — response body

Referenced models: Clone a CRM profile — response body

Schemas

Clone a CRM profile — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response body returned after a profile is successfully cloned. Additional keys: not allowed
profiles	array	Required within parent	Array containing the clone action result (contains at most one entry). Maximum items: 1
profiles[]	Model	Each item	Expand Clone a CRM profile — response body — profiles item

Referenced models: Clone a CRM profile — response body — profiles item

Clone a CRM profile — response body — profiles item

Field	Type	Presence	Description and constraints
$	object	Root	Response of a successful profile clone action. Additional keys: not allowed
code	string	Required within parent	Operation result code. Possible values: `SUCCESS`. Known values: SUCCESS
details	object	Required within parent	Represents the additional details returned with the clone operation result. Additional keys: not allowed
details.id	string	Required within parent	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. ID of the newly created (cloned) profile. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
message	string	Required within parent	Description of the clone operation result. Maximum length: 1000
status	string	Required within parent	Status of the operation result. Possible values: `success`. Known values: success

Policy, approvals and errors

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