Zoho: Profile — profiles delete Profile

← Profiles operations · Get started

Operation zoho.deleteprofile

Provider route: DELETE /crm/v8/settings/profiles/{id}. 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"]["deleteProfile"]>[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.deleteProfile(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.delete_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}$
query	object	Required within parent	Additional keys: not allowed
query.transfer_to	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}$

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
$	object	Root	Successful response for the profile delete operation. Additional keys: not allowed
code	string	Required within parent	The status code of the result. Possible values: SUCCESS Known values: SUCCESS
details	object	Required within parent	Additional details returned with the delete 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. Deleted profile ID. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
message	string	Required within parent	Human-readable message confirming the delete result. Maximum length: 500
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.deleteprofile. Catalog operation: deleteProfile. 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