Zoho: Portal User Type — portal User Type update Portal User Type

← Portal user type operations · Get started

Operation zoho.updateportalusertype

Provider route: PUT /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"]["updatePortalUserType"]>[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.updatePortalUserType(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.update_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
body	Model	Optional	Expand Portal User Type — portal User Type update Portal User Type — request body — body

Referenced models: Portal User Type — portal User Type update Portal User Type — request body — body

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 Portal User Type — portal User Type update Portal User Type — response body

Referenced models: Portal User Type — portal User Type update Portal User Type — response body

Schemas

5 more schemas are linked from the tables above, on the schema pages.

Portal User Type — portal User Type update Portal User Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Returned on successful update of a portal user type. Contains the identifier and name of the updated user type. Additional keys: not allowed
user_type	array	Required within parent	An array containing the result of the update operation, including the updated user type identifier. 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

Portal User Type — portal User Type update Portal User Type — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The request body schema for the update portal user type operation. Contains the `user_type` array with the fields to be updated. Additional keys: not allowed
user_type	array	Required within parent	An array containing the portal user type configuration to update. Must contain exactly one user type object with the fields to be modified. Maximum items: 1
user_type[]	Model	Each item	Expand Portal User Type — portal User Type update Portal User Type — request body — body user type item

Referenced models: Portal User Type — portal User Type update Portal User Type — request body — 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

Portal User Type — portal User Type update Portal User Type — request body — body user type item

Field	Type	Presence	Description and constraints
$	object	Root	A wrapper object used in update request bodies. Contains the `user_type` array that holds the portal user type object with the fields to be updated. Additional keys: not allowed
active	boolean or null	Optional	Set to `true` to activate the portal user type or `false` to deactivate it.
modules	array or null	Optional	Represents the list of modules whose properties you want to update within the portal user type. Maximum items: 1
modules[]	Model	Each item	Expand Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item
name	string or null	Optional	The updated display name for the portal user type. Must be alphanumeric with spaces only, maximum 50 characters. Maximum length: 50
personality_module	Model	Optional	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item personality module The updated personality module for the portal user type. Cannot be changed for the default user type.

Referenced models: Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item, Portal User Type — portal User Type create Portal User Type — request body — body user type item personality module

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

Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item

Field	Type	Presence	Description and constraints
$	object	Root	Used in update requests to modify module-level properties for an existing portal user type. Supports updating the shared type, allowed layouts, and filter-by field for the specified module. Additional keys: not allowed
filters	array or null	Optional	Represents the updated filter-by field configuration for the module. Specifies the CRM field by which portal users can filter records. Maximum items: 1
filters[]	Model	Each item	Expand Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item filters item
id	string	Optional	Represents the unique numeric identifier of the CRM module to be updated within the portal user type. Maximum length: 25 Pattern: ^[0-9]+$
layouts	array or null	Optional	Represents the updated list of CRM layouts accessible to portal users for this module. Maximum items: 1
layouts[]	Model	Each item	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item layouts item
permissions	Model	Optional	Expand Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item permissions The updated CRUD permissions for portal users on this module.
shared_type	string or null	Optional	The updated sharing mode for this module. Possible values: `public` (all records are shared with the portal user, and can be restricted using secondary conditions) or `private` (only records matching configured filter or secondary conditions are shared with the portal user). One of: public, private Maximum length: 7 Minimum length: 6
views	Model	Optional	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item views The updated list view (canvas view or custom view) accessible to portal users for this module.

Referenced models: Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item filters item, Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item layouts item, Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item permissions, Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item views

Portal User Type — portal User Type create Portal User Type — request body — body user type item personality module

Field	Type	Presence	Description and constraints
$	object	Root	A nested object used in create and update requests to specify the personality module for the portal user type. The personality module is the CRM module whose records serve as portal user identities and whose records portal invitations are sent to. Additional keys: not allowed
api_name	string	Optional	Represents the API Name of the Personality Module. Maximum length: 25 Pattern: ^[A-Za-z0-9_]{1,25}$
id	string	Optional	The unique numeric identifier of the personality module in Zoho CRM. Format: int64 Maximum length: 18

Portal User Type — portal User Type update Portal User Type — request body — body user type item modules item filters item

Field	Type	Presence	Description and constraints
$	object	Root	A nested object representing the filter configuration for a module in the portal user type, including the filter field's unique identifier, API name, and display label. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the resource Maximum length: 256
display_label	string	Optional	Represents the display label of the filter field. Maximum length: 255
id	string	Optional	Represents the unique identifier of the filter field. Maximum length: 25 Pattern: ^[0-9]+$

Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object representing a CRM layout that portal users can access for a given module. Identified by a unique numeric ID, name, and display label. Additional keys: not allowed
_default_view	Model	Optional	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item layouts item default view
display_label	string	Optional	Represents the display label of the CRM layout. Maximum length: 255
id	string	Optional	Specifies the unique identifier of the CRM layout. Maximum length: 25 Pattern: ^[0-9]+$
name	string	Optional	Represents the internal name of the CRM layout. Maximum length: 255

Referenced models: Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item layouts item default view

Policy, approvals and errors

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