Zoho: Portal User Type — portal User Type create Portal User Type

← Portal user type operations · Get started

Operation zoho.createportalusertype

Provider route: POST /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"]["createPortalUserType"]>[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.createPortalUserType(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.create_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
body	Model	Optional	Expand Portal User Type — portal User Type create Portal User Type — request body — body

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

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

Schemas

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

Portal User Type — portal User Type create Portal User Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Returned on successful creation of a new portal user type. Contains the identifier and name of the newly created user type. Additional keys: not allowed
user_type	array	Required within parent	An array containing the full configuration of the newly created portal user type, including its generated identifier. Maximum items: 1
user_type[]	Model	Each item	Expand Portal User Type — portal User Type create Portal User Type — response body — user type item

Referenced models: Portal User Type — portal User Type create Portal User Type — response body — user type item

Portal User Type — portal User Type create Portal User Type — request body — body

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

Referenced models: Portal User Type — portal User Type create Portal User Type — request body — body user type item

Portal User Type — portal User Type create Portal User Type — response body — user type item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object representing a single portal user type within a list operation response, containing summary-level configuration fields. Additional keys: not allowed
active	boolean	Optional	Indicates whether the portal user type is currently active and available to portal users.
default	boolean	Optional	Indicates whether this is the default portal user type in the organization. The default user type is created automatically when the portal is set up, using Contacts as the personality module.
id	string	Optional	Indicates the unique identifier of the resource. Format: int64 Maximum length: 255
invitation_field	Model	Optional	Expand Portal User Type — portal User Type create Portal User Type — response body — user type item invitation field
modules	array	Optional	Represents the array of modules associated with the user type. Maximum items: 4
modules[]	Model	Each item	Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item
name	string	Optional	Represents the name of the resource. Maximum length: 255
personality_module	Model	Optional	Expand Portal User Type — portal User Type create Portal User Type — response body — user type item personality module

Referenced models: Portal User Type — portal User Type create Portal User Type — response body — user type item invitation field, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item, Portal User Type — portal User Type create Portal User Type — response body — user type item personality module

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

Field	Type	Presence	Description and constraints
$	object	Root	A top-level wrapper object used in create and update request bodies. Contains the `user_type` array that holds one or more portal user type objects. Additional keys: not allowed
active	boolean or null	Optional	Indicates whether the portal user type is active. Set to `true` to allow portal users to access the portal via this user type, or `false` to deactivate it.
deactive_user_count	integer or null	Optional	The number of portal users assigned to this user type who are currently deactivated. Format: int32
id	string	Optional	Denotes the unique numeric identifier of the portal user type. Format: int64 Maximum length: 18 Read only: true
invitation_field	Model	Required within parent	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item invitation field The CRM field used as the invitation field for this portal user type. Portal invitations are sent to the contact value stored in this field. Required when creating a user type.
modules	array	Required within parent	The list of CRM modules with their access configurations for this portal user type. Required when creating a user type. Maximum items: 500
modules[]	Model	Each item	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item
name	string	Required within parent	The display name of the portal user type. For example, "Client Portal", "Vendor Portal", or "Partner Portal". Must be alphanumeric with spaces only, maximum 50 characters. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9 ]+$
personality_module	Model	Required within parent	Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item personality module The personality module for this portal user type. Records in this module serve as portal user identities, and portal invitations are sent to records in this module. Required when creating a user type.

Referenced models: Portal User Type — portal User Type create Portal User Type — request body — body user type item invitation field, Portal User Type — portal User Type create 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

Portal User Type — portal User Type create Portal User Type — response body — user type item invitation field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object used in create and update requests to specify the invitation field for the portal user type. The invitation field determines which CRM field stores the portal user's email address for sending invitations. Additional keys: not allowed
api_name	JSON	Optional
api_name (anyOf 1)	string	Alternative	Represents the API name of the CRM field to use as the invitation field for this portal user type. Maximum length: 255
api_name (anyOf 2)	null	Alternative	Represents the API name of the CRM field to use as the invitation field for this portal user type. Maximum length: 255
id	string	Optional	Represents the unique numeric identifier of the CRM field to use as the invitation field. Format: int64

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object representing the personality module as returned in response bodies, containing the module'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: 255
id	string	Optional	Represents the unique identifier of the resource. Format: int64 Maximum length: 255
plural_label	string	Optional	Represents the plural label of the module. Maximum length: 255

Portal User Type — portal User Type create Portal User Type — request body — body user type item invitation field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested object used in create and update requests to specify the invitation field for the portal user type. The invitation field determines which CRM field stores the portal user's email address for sending invitations. Additional keys: not allowed
api_name	string or null	Optional	Represents the API name of the CRM field to use as the invitation field for this portal user type. Maximum length: 255
id	string	Optional	Represents the unique numeric identifier of the CRM field to use as the invitation field. Format: int64

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 get Portal User Type — response body — user type item modules item filters null item

Field	Type	Presence	Description and constraints
$	object	Root	A nested object representing a filter field available for a module in the portal user type, identified by its unique ID, API name, and display label. Additional keys: not allowed
api_name	string	Optional	Represents the API name that uniquely identifies the filter field within the CRM module. Maximum length: 256
display_label	string	Optional	Represents the display label shown to portal users for the filter field. Maximum length: 50
id	string	Optional	Represents the unique numeric identifier of the filter field in Zoho CRM. Maximum length: 25 Pattern: ^[0-9]+$

Policy, approvals and errors

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