Zoho: Portal user type schemas
43 Zoho schemas with complete fields and constraints.
← Portal user type operations · All 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 |
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 — 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 — 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 modules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM module to which the portal user type grants access. Includes the module's unique identifier, API name, shared type, plural label, and the lists of allowed layouts, filter fields, and field-level permissions. Additional keys: not allowed |
api_name | string | Optional | Represents the API name that uniquely identifies the CRM module being granted portal access. Maximum length: 25 Pattern: ^[A-Za-z0-9_]{1,25}$ |
fields | array or null | Optional | Represents the list of CRM fields within this module that portal users are permitted to access. Each entry specifies the field identifier, API name, read-only flag, and per-field CRUD permissions. Maximum items: 500 |
fields[] | Model | Each item | Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item fields item |
filters | array or null | Optional | Represents the list of filter field configurations that portal users can use to filter records in this module. Maximum items: 1 |
filters[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item filters null item |
id | string | Required within parent | Represents the unique identifier of the CRM module. This field is required when specifying module access in a portal user type. Maximum length: 25 Pattern: ^[0-9]+$ |
layouts | array or null | Optional | The list of CRM layouts that portal users can access within this module. Maximum items: 7 |
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 | Required within parent | Expand Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item permissions The access permissions granted to portal users for this module. The `view` permission is required; all other permissions are optional and module-dependent. |
plural_label | string or null | Optional | Represents the plural display label of the CRM module. Maximum length: 255 |
shared_type | string | Required within parent | Specifies how records in this module are shared with portal users. This field is required. Possible values: `all_records`, `selected_records`, `related_records`. One of: private, public Maximum length: 255 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 list view (canvas view or custom view) visible to portal users when browsing records in this module. |
Referenced models: Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item fields item, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item filters null 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 create 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 modules item fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field that is accessible to portal users for the configured module. Includes the field's unique identifier, API name, read-only flag, and the list of per-field CRUD permissions. Additional keys: not allowed |
api_name | string | Optional | The API name of the CRM field accessible to portal users within this module. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$ |
id | string | Optional | The unique numeric identifier of the CRM field. Format: int64 |
permissions | array | Optional | Represents the list of CRUD permission entries that control what portal users can do with this field. Maximum items: 25 |
permissions[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item |
read_only | boolean or null | Optional | Denotes whether the field is read-only for portal users. When `true`, portal users can view the field value but cannot modify it. |
Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item
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
Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item layouts item default view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Nested schema for _default_view representing the default view configuration associated with the portal user type, including the view's unique identifier, name, display label, and type. |
$ (anyOf 1) | Model | Alternative | Expand Portal User Type — portalUserType.createPortalUserType — request body — body / user_type / item / modules / item / layouts / item / _default_view / type: layout |
$ (anyOf 2) | Model | Alternative | Expand Portal User Type — portalUserType.createPortalUserType — request body — body / user_type / item / modules / item / layouts / item / _default_view / type: wizard |
Referenced models: Portal User Type — portalUserType.createPortalUserType — request body — body / user_type / item / modules / item / layouts / item / _default_view / type: layout, Portal User Type — portalUserType.createPortalUserType — request body — body / user_type / item / modules / item / layouts / item / _default_view / type: wizard
Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item permissions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines the access permissions granted to portal users for a specific CRM module. Includes flags for create, edit, delete, view, and attachment operations. Additional keys: not allowed |
create | boolean or null | Optional | Denotes whether portal users can create new records in this module. Set to `true` to enable create access. |
create_attachment | boolean or null | Optional | Denotes whether portal users can add attachments to notes associated with records in this module. |
delete | boolean or null | Optional | Denotes whether portal users can delete records in this module. Set to `true` to enable delete access. |
delete_attachment | boolean or null | Optional | Denotes whether portal users can delete attachments from notes associated with records in this module. |
edit | boolean or null | Optional | Denotes whether portal users can edit records in this module that they created. Set to `true` to enable edit access for portal-user-created records. |
edit_shared_records | boolean or null | Optional | Denotes whether portal users can edit records in this module that were shared with them from CRM, but not created by them. |
view | boolean | Required within parent | Denotes whether portal users can view records in this module. View permission must be `true` for any other permission to take effect. |
Portal User Type — portal User Type create Portal User Type — request body — body user type item modules item views
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | A nested object representing a list view associated with a portal user type module. Identified by a unique numeric ID, name, display label, and type. Additional keys: not allowed |
display_label | string | Optional | Represents the display label of the list view shown to portal users. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the resource. Maximum length: 25 Pattern: ^[0-9]+$ |
name | string | Optional | Represents the name of the resource. Maximum length: 255 |
type | string | Optional | The type of the list view. Possible values: `canvas_view` (Canvas View), `custom_view` (Custom List View). One of: canvas_view, custom_view Maximum length: 255 |
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 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 — 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 — 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 get Portal User Type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Returned on a successful request to retrieve a single portal user type by ID. Contains the full configuration of the requested user type. Additional keys: not allowed |
user_type | array | Required within parent | An array containing the full configuration of the requested portal user type. Always contains exactly one entry. Maximum items: 1 |
user_type[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item |
Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item
Portal User Type — portal User Type get Portal User Type — response body — user type item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The full configuration details of a single portal user type, including identity fields, active status, user counts, audit metadata, and per-module access permissions. Additional keys: not allowed |
active | boolean | Required within parent | Indicates whether the portal user type is currently active and available to portal users. |
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]+)?$ |
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 | 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 |
modules | array | Required within parent | The list of CRM modules that portal users of this type are permitted to access, along with the permissions and layouts configured for each module. Maximum items: 500 |
modules[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item |
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 Type — portal User Type get Portal User Type — response body — user type item modules item
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM module to which the portal user type grants access. Includes the module's unique identifier, API name, shared type, plural label, and the lists of allowed layouts, filter fields, and field-level permissions. Additional keys: not allowed |
api_name | string | Optional | Represents the API name that uniquely identifies the CRM module being granted portal access. Maximum length: 25 Pattern: ^[A-Za-z0-9_]{1,25}$ |
fields | JSON | Optional | |
fields (anyOf 1) | array | Alternative | Represents the list of CRM fields within this module that portal users are permitted to access. Each entry specifies the field identifier, API name, read-only flag, and per-field CRUD permissions. Maximum items: 500 |
fields (anyOf 1)[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item |
fields (anyOf 2) | null | Alternative | Represents the list of CRM fields within this module that portal users are permitted to access. Each entry specifies the field identifier, API name, read-only flag, and per-field CRUD permissions. Maximum items: 500 |
fields (anyOf 2)[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item |
filters | JSON | Optional | |
filters (anyOf 1) | array | Alternative | Represents the list of filter field configurations that portal users can use to filter records in this module. Maximum items: 1 |
filters (anyOf 1)[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item filters null item |
filters (anyOf 2) | null | Alternative | Represents the list of filter field configurations that portal users can use to filter records in this module. Maximum items: 1 |
filters (anyOf 2)[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item filters null item |
id | string | Required within parent | Represents the unique identifier of the CRM module. This field is required when specifying module access in a portal user type. Maximum length: 25 Pattern: ^[0-9]+$ |
layouts | JSON | Optional | |
layouts (anyOf 1) | array | Alternative | The list of CRM layouts that portal users can access within this module. Maximum items: 7 |
layouts (anyOf 1)[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item |
layouts (anyOf 2) | null | Alternative | The list of CRM layouts that portal users can access within this module. Maximum items: 7 |
layouts (anyOf 2)[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item |
permissions | Model | Required within parent | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item permissions The access permissions granted to portal users for this module. The `view` permission is required; all other permissions are optional and module-dependent. |
plural_label | JSON | Optional | |
plural_label (anyOf 1) | string | Alternative | Represents the plural display label of the CRM module. Maximum length: 255 |
plural_label (anyOf 2) | null | Alternative | Represents the plural display label of the CRM module. Maximum length: 255 |
shared_type | string | Required within parent | Specifies how records in this module are shared with portal users. This field is required. Possible values: `all_records`, `selected_records`, `related_records`. Known values: private, public Maximum length: 255 Minimum length: 6 |
views | JSON | Optional | |
views (anyOf 1) | Model | Alternative | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item views value The list view (canvas view or custom view) visible to portal users when browsing records in this module. |
views (anyOf 2) | Model | Alternative | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item views value The list view (canvas view or custom view) visible to portal users when browsing records in this module. |
Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item modules item filters null item, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item permissions, Portal User Type — portal User Type get Portal User Type — response body — user type item modules item views value
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field that is accessible to portal users for the configured module. Includes the field's unique identifier, API name, read-only flag, and the list of per-field CRUD permissions. Additional keys: not allowed |
api_name | string | Optional | The API name of the CRM field accessible to portal users within this module. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$ |
id | string | Optional | The unique numeric identifier of the CRM field. Format: int64 |
permissions | array | Optional | Represents the list of CRUD permission entries that control what portal users can do with this field. Maximum items: 25 |
permissions[] | Model | Each item | Expand Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item |
read_only | JSON | Optional | |
read_only (anyOf 1) | boolean | Alternative | Denotes whether the field is read-only for portal users. When `true`, portal users can view the field value but cannot modify it. |
read_only (anyOf 2) | null | Alternative | Denotes whether the field is read-only for portal users. When `true`, portal users can view the field value but cannot modify it. |
Referenced models: Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item fields null item permissions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A permission entry that specifies what portal users can do with a specific CRUD action (create, edit, delete, or view) for this field. Additional keys: not allowed |
create | boolean | Optional | Whether portal users can set a value for this field when creating a record. |
delete | boolean | Optional | Whether portal users can delete records that have this field. |
edit | boolean | Optional | Whether portal users can edit the value of this field on existing records. |
iscustomizable | boolean | Required within parent | Whether the field permission for this action can be customized per portal user type. |
view | boolean | Optional | Whether portal users can view the value of this field. |
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]+$ |
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null 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 get Portal User Type — response body — user type item modules item layouts null 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 get Portal User Type — response body — user type item modules item layouts null item default view
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item layouts null item default view
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Nested schema for _default_view representing the default view configuration associated with the portal user type, including the view's unique identifier, name, display label, and type. |
$ (anyOf 1) | Model | Alternative | Expand Portal User Type — portalUserType.getPortalUserType — response body — user_type / item / modules / item / layouts / null / item / _default_view / type: layout |
$ (anyOf 2) | Model | Alternative | Expand Portal User Type — portalUserType.getPortalUserType — response body — user_type / item / modules / item / layouts / null / item / _default_view / type: wizard |
Referenced models: Portal User Type — portalUserType.getPortalUserType — response body — user_type / item / modules / item / layouts / null / item / _default_view / type: layout, Portal User Type — portalUserType.getPortalUserType — response body — user_type / item / modules / item / layouts / null / item / _default_view / type: wizard
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item permissions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines the access permissions granted to portal users for a specific CRM module. Includes flags for create, edit, delete, view, and attachment operations. Additional keys: not allowed |
create | JSON | Optional | |
create (anyOf 1) | boolean | Alternative | Denotes whether portal users can create new records in this module. Set to `true` to enable create access. |
create (anyOf 2) | null | Alternative | Denotes whether portal users can create new records in this module. Set to `true` to enable create access. |
create_attachment | JSON | Optional | |
create_attachment (anyOf 1) | boolean | Alternative | Denotes whether portal users can add attachments to notes associated with records in this module. |
create_attachment (anyOf 2) | null | Alternative | Denotes whether portal users can add attachments to notes associated with records in this module. |
delete | JSON | Optional | |
delete (anyOf 1) | boolean | Alternative | Denotes whether portal users can delete records in this module. Set to `true` to enable delete access. |
delete (anyOf 2) | null | Alternative | Denotes whether portal users can delete records in this module. Set to `true` to enable delete access. |
delete_attachment | JSON | Optional | |
delete_attachment (anyOf 1) | boolean | Alternative | Denotes whether portal users can delete attachments from notes associated with records in this module. |
delete_attachment (anyOf 2) | null | Alternative | Denotes whether portal users can delete attachments from notes associated with records in this module. |
edit | JSON | Optional | |
edit (anyOf 1) | boolean | Alternative | Denotes whether portal users can edit records in this module that they created. Set to `true` to enable edit access for portal-user-created records. |
edit (anyOf 2) | null | Alternative | Denotes whether portal users can edit records in this module that they created. Set to `true` to enable edit access for portal-user-created records. |
edit_shared_records | JSON | Optional | |
edit_shared_records (anyOf 1) | boolean | Alternative | Denotes whether portal users can edit records in this module that were shared with them from CRM, but not created by them. |
edit_shared_records (anyOf 2) | null | Alternative | Denotes whether portal users can edit records in this module that were shared with them from CRM, but not created by them. |
view | boolean | Required within parent | Denotes whether portal users can view records in this module. View permission must be `true` for any other permission to take effect. |
Portal User Type — portal User Type get Portal User Type — response body — user type item modules item views value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | A nested object representing a list view associated with a portal user type module. Identified by a unique numeric ID, name, display label, and type. Additional keys: not allowed |
$ (anyOf 1).display_label | string | Optional | Represents the display label of the list view shown to portal users. Maximum length: 255 |
$ (anyOf 1).id | string | Optional | Represents the unique identifier of the resource. Maximum length: 25 Pattern: ^[0-9]+$ |
$ (anyOf 1).name | string | Optional | Represents the name of the resource. Maximum length: 255 |
$ (anyOf 1).type | string | Optional | The type of the list view. Possible values: `canvas_view` (Canvas View), `custom_view` (Custom List View). Known values: canvas_view, custom_view Maximum length: 255 |
$ (anyOf 2) | null | Alternative | A nested object representing a list view associated with a portal user type module. Identified by a unique numeric ID, name, display label, and type. Additional keys: not allowed |
$ (anyOf 2).display_label | string | Optional | Represents the display label of the list view shown to portal users. Maximum length: 255 |
$ (anyOf 2).id | string | Optional | Represents the unique identifier of the resource. Maximum length: 25 Pattern: ^[0-9]+$ |
$ (anyOf 2).name | string | Optional | Represents the name of the resource. Maximum length: 255 |
$ (anyOf 2).type | string | Optional | The type of the list view. Possible values: `canvas_view` (Canvas View), `custom_view` (Custom List View). Known values: canvas_view, custom_view Maximum length: 255 |
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
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
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 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 update Portal User Type — request body — body user type item modules item permissions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Used in update requests to modify the CRUD and shared-record permissions for a module within an existing portal user type. Additional keys: not allowed |
create | boolean | Optional | Represents the updated create permission for portal users on this module. Set to `true` to allow portal users to create records. |
delete | boolean | Optional | Represents the updated delete permission for portal users on this module. Set to `true` to allow portal users to delete records. |
edit | boolean | Optional | Represents the updated edit permission for portal users on records they created in this module. |
edit_shared_records | boolean | Optional | Represents the updated permission for portal users to edit records shared from CRM into this module. |
view | boolean | Optional | Represents the updated view permission for portal users on this module. |
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 — portalUserType.createPortalUserType — request body — body / user_type / item / modules / item / layouts / item / _default_view / type: layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for _default_view when type is layout Additional keys: not allowed |
display_label | string | Optional | Represents the display label of the default layout view. Maximum length: 255 |
id | string | Optional | Represents the unique numeric identifier of the default view. Maximum length: 25 Pattern: ^[0-9]+$ |
name | string | Optional | Represents the internal name of the default view. Maximum length: 255 |
type | string | Optional | The type of the default view. One of: layout Maximum length: 255 |
Portal User Type — portalUserType.createPortalUserType — request body — body / user_type / item / modules / item / layouts / item / _default_view / type: wizard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for _default_view when type is wizard Additional keys: not allowed |
display_label | string | Optional | The display label of the resource Maximum length: 255 |
id | string | Optional | The unique identifier of the resource Format: int64 Maximum length: 19 |
name | string | Optional | The name of the resource Maximum length: 255 |
type | string | Optional | The type of the resource One of: wizard Maximum length: 255 |
Portal User Type — portalUserType.getPortalUserType — response body — user_type / item / modules / item / layouts / null / item / _default_view / type: layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for _default_view when type is layout Additional keys: not allowed |
display_label | string | Optional | Represents the display label of the default layout view. Maximum length: 255 |
id | string | Optional | Represents the unique numeric identifier of the default view. Maximum length: 25 Pattern: ^[0-9]+$ |
name | string | Optional | Represents the internal name of the default view. Maximum length: 255 |
type | string | Optional | The type of the default view. Known values: layout Maximum length: 255 |
Portal User Type — portalUserType.getPortalUserType — response body — user_type / item / modules / item / layouts / null / item / _default_view / type: wizard
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Nested schema for _default_view when type is wizard Additional keys: not allowed |
display_label | string | Optional | The display label of the resource Maximum length: 255 |
id | string | Optional | The unique identifier of the resource Format: int64 Maximum length: 19 |
name | string | Optional | The name of the resource Maximum length: 255 |
type | string | Optional | The type of the resource Known values: wizard Maximum length: 255 |
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 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 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 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 |
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 |