Zoho: Delete a user group

← User groups operations · Get started

Operation zoho.deletegroup

Provider route: DELETE /crm/v8/settings/user_groups/{group}. 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["userGroups"]["deleteGroup"]>[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.userGroups.deleteGroup(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.user_groups.delete_group(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.group	string	Required within parent	One of: 1234567890

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	Response schema for a successful user group deletion or scheduled deletion. Additional keys: not allowed
user_groups	array	Required within parent	Represents the array containing the result of the user group deletion operation. Maximum items: 1
user_groups[]	object	Each item	Represents the deletion result for the user group, indicating whether it completes immediately or queues for background processing. Additional keys: not allowed
user_groups[].code	string	Required within parent	Represents the result code for the user group deletion operation. Possible values: SUCCESS - The user group deletion completes immediately. SCHEDULED - The user group deletion queues for background processing; the response includes a job ID. Known values: SUCCESS, SCHEDULED
user_groups[].details	JSON	Required within parent	Represents additional details about the deletion result, containing either the deleted group ID or a scheduled job ID.
user_groups[].details (anyOf 1)	object	Alternative	Present when deletion completes immediately. Contains the deleted group ID. Additional keys: not allowed
user_groups[].details (anyOf 1).id	string	Required within parent	Represents the unique ID of the user group for which deletion completes immediately. Present in immediate-deletion responses. Maximum length: 19
user_groups[].details (anyOf 2)	object	Alternative	Present when the deletion was queued for background processing. Contains the scheduled job ID. Additional keys: not allowed
user_groups[].details (anyOf 2).job_id	string	Required within parent	Represents the ID of the scheduled deletion job. Present when the deletion is queued for background processing. Maximum length: 19
user_groups[].message	string	Required within parent	Represents the result message for the user group deletion operation. Maximum length: 500
user_groups[].status	string	Required within parent	Represents the status of the user group deletion operation. Possible values: success - The user group deletion completes immediately. scheduled - The user group deletion queues for background processing. Known values: success, scheduled

Policy, approvals and errors

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