Zoho: Portal User Types

← Portal user type operations · Get started

Operation zoho.getportalusertypes

Provider route: GET /crm/v8/settings/portals/{portal}/user_type. 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"]["getPortalUserTypes"]>[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.getPortalUserTypes(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.get_portal_user_types(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
query	object	Optional	Additional keys: not allowed
query.include	string	Optional	One of: modules
query.include_inner_details	string	Optional	One of: field.field_label

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 Types — response body

Referenced models: Portal User Types — response body

Schemas

Portal User Types — response body

Field	Type	Presence	Description and constraints
$	object	Root	Returned on a successful request to list all portal user types. Contains an array of user type summary objects. Additional keys: not allowed
user_type	array	Required within parent	An array of portal user type summary objects, one per user type configured in the portal. Maximum items: 5
user_type[]	Model	Each item	Expand Portal User Types — response body — user type item

Referenced models: Portal User Types — response body — user type item

Portal User Types — response body — user type item

Field	Type	Presence	Description and constraints
$	object	Root	A summary representation of a portal user type as returned by the list operation, including identity fields, active status, user counts, and last modification timestamp. Additional keys: not allowed
active	boolean	Required within parent	Indicates whether the portal user type is currently active.
active_user_count	JSON	Required within parent
active_user_count (anyOf 1)	integer	Alternative	Represents the number of portal users currently assigned to and active under this user type. Format: int32
active_user_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_by	Model	Required within parent	Expand Portal User Types — response body — user type item created by
created_time	string	Required within parent	Represents the creation timestamp of the user type. Maximum length: 255
deactive_user_count	JSON	Required within parent
deactive_user_count (anyOf 1)	integer	Alternative	Represents the number of portal users assigned to this user type who have been deactivated. Format: int32
deactive_user_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default	boolean	Required within parent	Indicates whether this is the default portal user type in the organization. The default user type is automatically assigned when no explicit user type is specified.
id	string	Required within parent	Represents the unique numeric identifier of the portal user type. Format: int64 Maximum length: 255
invitation_field	Model	Required within parent	Expand Portal User Types — response body — user type item invitation field
modified_by	Model	Required within parent	Expand Portal User Types — response body — user type item modified by
modified_time	string	Required within parent	Represents the ISO 8601 timestamp of when the portal user type was last modified. Maximum length: 255
name	string	Required within parent	Represents the name of the portal user type. Maximum length: 255
personality_module	Model	Required within parent	Expand Portal User Types — response body — user type item personality module

Referenced models: Portal User Types — response body — user type item invitation field, Portal User Types — response body — user type item personality module, Portal User Types — response body — user type item created by, Portal User Types — response body — user type item modified by

Portal User Types — response body — user type item invitation field

Field	Type	Presence	Description and constraints
$	object	Root	The invitation field configured for the portal user type. This is the CRM field used to store the portal user's email address, to which portal invitations are sent. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the CRM field designated as the invitation field for sending portal invitations. Maximum length: 255
id	string	Required within parent	Represents the unique numeric identifier of the invitation field in Zoho CRM. Format: int64 Maximum length: 255

Portal User Types — response body — user type item personality module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object identifying the personality module configured for the portal user type. The personality module is the CRM module (for example, Contacts) whose records serve as portal user identities. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the CRM module configured as the personality module for this portal user type. Maximum length: 255
id	string	Required within parent	Represents the unique numeric identifier of the personality module in Zoho CRM. Format: int64 Maximum length: 255
plural_label	string	Required within parent	Represents the plural label of the module. Maximum length: 255

Portal User Types — response body — user type item created by

Field	Type	Presence	Description and constraints
$	object	Root	Represents nested object identifying the Zoho CRM user who created the portal user type, containing the user's unique identifier and display name. Additional keys: not allowed
id	string	Required within parent	Represents the unique numeric identifier of the Zoho CRM user who created the portal user type. Format: int64 Maximum length: 255
name	string	Required within parent	Represents the display name of the Zoho CRM user who created the portal user type. Maximum length: 255

Portal User Types — response body — user type item modified by

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object identifying the Zoho CRM user who last modified the portal user type, containing the user's unique identifier and display name. Additional keys: not allowed
id	string	Required within parent	Represents the unique numeric identifier of the Zoho CRM user who last modified the portal user type. Format: int64 Maximum length: 255
name	string	Required within parent	Represents the display name of the Zoho CRM user who last modified the portal user type. Maximum length: 255

Policy, approvals and errors

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