> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> Create portal user type. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.
Create portal user type.
Tool ID: `zoho_crm_portal_user_type_create_portal_user_type`
## Run this action
This action has conditional or dynamic input fields that cannot be represented by a reliable static example.
Inspect the live contract before executing it:
```bash theme={null}
deepline tools get zoho_crm_portal_user_type_create_portal_user_type --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_portal_user_type_create_portal_user_type --json` for the complete live contract.
## Input reference
Request schema for creating portal user types.
| Name | Type | Required | Default | Details |
| ------------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.portal` | `string` | Yes | — | Portal unique name (path parameter). Provide the portal identifier as defined in the account. Minimum length: 1. Maximum length: 255. |
| `payload.user_type` | `array` | Yes | — | Array of user type objects to create. Minimum items: 1. Maximum items: 1000. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Request schema for creating portal user types.",
"properties": {
"portal": {
"type": "string",
"description": "Portal unique name (path parameter). Provide the portal identifier as defined in the account.",
"minLength": 1,
"maxLength": 255
},
"user_type": {
"type": "array",
"description": "Array of user type objects to create.",
"minItems": 1,
"maxItems": 1000,
"uniqueItems": false,
"items": {
"type": "object",
"description": "Portal user type object for creation.",
"properties": {
"personality_module": {
"type": "object",
"description": "Personality module details for the user type.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the personality module.",
"maxLength": 25,
"pattern": "^[A-Za-z0-9 ]{1,25}$"
},
"id": {
"type": "string",
"description": "Long id represented as digits string.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"plural_label": {
"type": "string",
"description": "Plural label for the personality module.",
"maxLength": 255
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": true
},
"name": {
"type": "string",
"description": "Name of the user type.",
"maxLength": 255
},
"modules": {
"type": "array",
"description": "Modules to assign to this user type.",
"minItems": 0,
"maxItems": 1000,
"uniqueItems": true,
"items": {
"type": "object",
"description": "Module object for assignment.",
"properties": {
"id": {
"type": "string",
"description": "Module id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"api_name": {
"type": "string",
"description": "API name of the module.",
"maxLength": 25,
"pattern": "^[A-Za-z0-9 ]{1,25}$"
},
"shared_type": {
"type": "string",
"description": "Shared type of the module.",
"enum": [
"public",
"private"
]
},
"plural_label": {
"type": "string",
"description": "Plural label for the module.",
"maxLength": 255
},
"permissions": {
"type": "object",
"description": "Permissions for the module.",
"properties": {
"view": {
"type": "boolean",
"description": "Permission to view records."
},
"edit": {
"type": "boolean",
"description": "Permission to edit records."
},
"create": {
"type": "boolean",
"description": "Permission to create records."
},
"delete": {
"type": "boolean",
"description": "Permission to delete records."
},
"edit_shared_records": {
"type": "boolean",
"description": "Permission to edit shared records."
},
"create_attachment": {
"type": "boolean",
"description": "Permission to create attachments."
},
"delete_attachment": {
"type": "boolean",
"description": "Permission to delete attachments."
}
},
"additionalProperties": true
},
"fields": {
"type": [
"array",
"null"
],
"description": "Fields accessible in the module.",
"uniqueItems": true,
"items": {
"type": "object",
"description": "Field object.",
"properties": {
"id": {
"type": "string",
"description": "Field id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"api_name": {
"type": "string",
"description": "API name of the field.",
"maxLength": 255
},
"read_only": {
"type": "boolean",
"description": "Indicates if the field is read-only."
}
},
"required": [
"id"
],
"additionalProperties": true
}
},
"filters": {
"type": [
"array",
"null"
],
"description": "Filters available for the module.",
"uniqueItems": true,
"items": {
"type": "object",
"description": "Filter object.",
"properties": {
"id": {
"type": "string",
"description": "Filter id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"api_name": {
"type": "string",
"description": "API name of the filter.",
"maxLength": 255
},
"display_label": {
"type": "string",
"description": "Display label for the filter.",
"maxLength": 255
}
},
"required": [
"id",
"api_name",
"display_label"
],
"additionalProperties": true
}
},
"layouts": {
"type": [
"array",
"null"
],
"description": "Layouts available for the module.",
"uniqueItems": true,
"items": {
"type": "object",
"description": "Layout object.",
"properties": {
"id": {
"type": "string",
"description": "Layout id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"name": {
"type": "string",
"description": "Name of the layout.",
"maxLength": 255
},
"display_label": {
"type": "string",
"description": "Display label for the layout.",
"maxLength": 255
}
},
"required": [
"id"
],
"additionalProperties": true
}
},
"views": {
"type": [
"object",
"null"
],
"description": "View object for the module.",
"properties": {
"id": {
"type": "string",
"description": "View id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"type": {
"type": "string",
"description": "Type of the view.",
"maxLength": 255
},
"name": {
"type": "string",
"description": "Name of the view.",
"maxLength": 255
},
"display_label": {
"type": "string",
"description": "Display label for the view.",
"maxLength": 255
}
},
"required": [
"id",
"type"
],
"additionalProperties": true
},
"custom_views": {
"type": [
"array",
"null"
],
"description": "Custom views for the module.",
"uniqueItems": true,
"items": {
"type": "object",
"description": "Custom view object.",
"properties": {
"id": {
"type": "string",
"description": "Custom view id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"name": {
"type": "string",
"description": "Name of the custom view.",
"maxLength": 255
},
"deleted": {
"type": "boolean",
"description": "Indicates if the custom view is deleted."
}
},
"required": [
"id",
"name",
"deleted"
],
"additionalProperties": true
}
}
},
"required": [
"id",
"shared_type",
"permissions"
],
"additionalProperties": true
}
},
"invitation_field": {
"type": "object",
"description": "Field used for invitation.",
"properties": {
"id": {
"type": "string",
"description": "Invitation field id.",
"maxLength": 255,
"pattern": "^[0-9]+$"
},
"api_name": {
"type": "string",
"description": "API name of the invitation field.",
"maxLength": 255
}
},
"required": [
"id"
],
"additionalProperties": true
}
},
"required": [
"personality_module",
"name",
"modules",
"invitation_field"
],
"additionalProperties": true
}
}
},
"required": [
"portal",
"user_type"
],
"additionalProperties": true
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------- | -------- | -------- | ------- | --------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Successful response schema for created portal user types. |
| `result.data.user_type` | `array` | No | — | Array of created portal user type objects. Maximum items: 1000. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Successful response schema for created portal user types.",
"properties": {
"user_type": {
"type": "array",
"description": "Array of created portal user type objects.",
"maxItems": 1000,
"items": {
"type": "object",
"description": "Portal user type object.",
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)