> ## 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
> Invite portal users. Zoho CRM Portal Users Single Invite User reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline.
Invite portal users.
Tool ID: `zoho_crm_portal_users_single_invite_user`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_portal_users_single_invite_user',
{
"module": "example",
"recordId": "record_123",
"user_type_id": "user_type_123",
"type": "reinvite"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_portal_users_single_invite_user --input '{
"module": "example",
"recordId": "record_123",
"user_type_id": "user_type_123",
"type": "reinvite"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"portal_invite": [
{
"code": "SUCCESS",
"details": {
"record_id": "record_123"
}
}
]
}
}
```
Use `deepline tools get zoho_crm_portal_users_single_invite_user --json` for the latest machine-readable contract.
## Input reference
Send invitations to portal users for a specific module.
| Name | Type | Required | Default | Details |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.module` | `string` | Yes | — | The CRM module name for portal invitation Maximum length: 255. |
| `payload.recordId` | `string` | Yes | — | The unique identifier of the record Maximum length: 255. |
| `payload.language` | `"" \| "it_IT" \| "ru_RU" \| "pl_PL" \| "tr_TR" \| "hi_IN" \| "pt_BR" \| "th_TH" \| "fr_FR" \| "ja_JP" \| "in_ID" \| "cs_CZ" \| "de_DE" \| "hu_HU" \| "zh_TW" \| "es_ES" \| "nl_NL" \| "sv_SE" \| "da_DK" \| "bg_BG" \| "vi_VN" \| "iw_IL" \| "hr_HR" \| "en_GB" \| "ko_KR" \| "en_US" \| "zh_CN" \| "ar_EG" \| "pt_PT"` | No | — | Preferred language for the invitation Allowed: \`\`, `it_IT`, `ru_RU`, `pl_PL`, `tr_TR`, `hi_IN`, `pt_BR`, `th_TH`, `fr_FR`, `ja_JP`, `in_ID`, `cs_CZ`, `de_DE`, `hu_HU`, `zh_TW`, `es_ES`, `nl_NL`, `sv_SE`, `da_DK`, `bg_BG`, `vi_VN`, `iw_IL`, `hr_HR`, `en_GB`, `ko_KR`, `en_US`, `zh_CN`, `ar_EG`, `pt_PT`. |
| `payload.user_type_id` | `string` | Yes | — | User type identifier Maximum length: 255. |
| `payload.type` | `"reinvite" \| "invite"` | Yes | — | Invitation type Allowed: `reinvite`, `invite`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Send invitations to portal users for a specific module.",
"properties": {
"module": {
"type": "string",
"description": "The CRM module name for portal invitation",
"maxLength": 255
},
"recordId": {
"type": "string",
"description": "The unique identifier of the record",
"maxLength": 255
},
"language": {
"type": "string",
"description": "Preferred language for the invitation",
"enum": [
"",
"it_IT",
"ru_RU",
"pl_PL",
"tr_TR",
"hi_IN",
"pt_BR",
"th_TH",
"fr_FR",
"ja_JP",
"in_ID",
"cs_CZ",
"de_DE",
"hu_HU",
"zh_TW",
"es_ES",
"nl_NL",
"sv_SE",
"da_DK",
"bg_BG",
"vi_VN",
"iw_IL",
"hr_HR",
"en_GB",
"ko_KR",
"en_US",
"zh_CN",
"ar_EG",
"pt_PT"
]
},
"user_type_id": {
"type": "string",
"description": "User type identifier",
"maxLength": 255
},
"type": {
"type": "string",
"description": "Invitation type",
"enum": [
"reinvite",
"invite"
]
}
},
"required": [
"module",
"recordId",
"user_type_id",
"type"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------- | ----------- | -------- | ------- | ------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Response for portal user invitation requests |
| `result.data.portal_invite` | `array` | Yes | — | List of portal invitation responses Maximum items: 100. |
| `result.data.portal_invite[].code` | `"SUCCESS"` | Yes | — | Status code indicating invitation was scheduled Allowed: `SUCCESS`. |
| `result.data.portal_invite[].details` | `object` | Yes | — | Additional details about the scheduled invitation |
| `result.data.portal_invite[].details.record_id` | `string` | Yes | — | Record id of portal user Maximum length: 255. |
| `result.data.portal_invite[].message` | `string` | No | — | Success message Maximum length: 1000. |
| `result.data.portal_invite[].status` | `"success"` | No | — | Status of the response Allowed: `success`. |
| `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": "Response for portal user invitation requests",
"properties": {
"portal_invite": {
"type": "array",
"description": "List of portal invitation responses",
"maxItems": 100,
"items": {
"type": "object",
"description": "Portal invitation response object",
"properties": {
"code": {
"type": "string",
"description": "Status code indicating invitation was scheduled",
"enum": [
"SUCCESS"
]
},
"details": {
"type": "object",
"description": "Additional details about the scheduled invitation",
"properties": {
"record_id": {
"type": "string",
"description": "Record id of portal user",
"maxLength": 255
}
},
"required": [
"record_id"
],
"additionalProperties": false
},
"message": {
"type": "string",
"description": "Success message",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"success"
]
}
},
"required": [
"code",
"details"
],
"additionalProperties": false
}
}
},
"required": [
"portal_invite"
],
"additionalProperties": false
},
"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)