Zoho: Delete user type

← Portal user type operations · Get started

Operation zoho.deleteportalusertype

Provider route: DELETE /crm/v8/settings/portals/{portal}/user_type/{userTypeId}. 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["portalUserType"]["deletePortalUserType"]>[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.portalUserType.deletePortalUserType(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.portal_user_type.delete_portal_user_type(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.portal	string	Required within parent	Represents the unique name of the portal. Maximum length: 255
path.userTypeId	string	Required within parent	Represents the unique numeric identifier of the portal user type. Format: int64 Maximum length: 255
query	object	Optional	Additional keys: not allowed
query.transfer_To	string	Optional	Represents the unique numeric identifier of the portal user type. Format: int64 Maximum length: 255 Pattern: ^[0-9]+$

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 Delete user type — response body

Referenced models: Delete user type — response body

Schemas

Delete user type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Returned on successful deletion of a portal user type. Contains the name of the deleted user type. Additional keys: not allowed
user_type	array	Required within parent	An array containing the result of the delete operation, including the identifier of the deleted user type. Maximum items: 1
user_type[]	Model	Each item	Expand Delete user type — response body — user type item

Referenced models: Delete user type — response body — user type item

Delete user type — response body — user type item

Field	Type	Presence	Description and constraints
$	object	Root	A nested object representing a single portal user type within a get-by-ID response, containing the full configuration including module access details. Additional keys: not allowed
code	string	Optional	The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`. Maximum length: 255
details	Model	Optional	Expand Delete user type — response body — user type item details
message	string	Optional	Represents the error message that Zoho CRM returned, describing what went wrong. Maximum length: 255
status	string	Optional	Represents the result status of the API call. The value is `error` for all error responses. Maximum length: 255

Referenced models: Delete user type — response body — user type item details

Delete user type — response body — user type item details

Field	Type	Presence	Description and constraints
$	object	Root	A nested object containing additional detail fields returned with error responses, such as the field API name and JSON path that identify where the validation failure occurred. Additional keys: not allowed
id	string	Optional	Represents the unique numeric identifier of the resource referenced in the error detail. Format: int64 Maximum length: 255

Policy, approvals and errors

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