> ## 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 Get Scheduled Invite Users Info reference includes SDK V2 and CLI requests, input constraints, response fields,.
Invite portal users.
Tool ID: `zoho_crm_portal_users_get_scheduled_invite_users_info`
## 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_get_scheduled_invite_users_info',
{
"module": "example"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_portal_users_get_scheduled_invite_users_info --input '{
"module": "example"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"portal_invite": [
{
"data": [
{}
],
"job_id": "job_123",
"status": "scheduled"
}
]
}
}
```
Use `deepline tools get zoho_crm_portal_users_get_scheduled_invite_users_info --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.job_id` | `string` | No | — | Job ID to fetch the status of the portal user invitations Maximum length: 255. |
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
},
"job_id": {
"type": "string",
"description": "Job ID to fetch the status of the portal user invitations",
"maxLength": 255
}
},
"required": [
"module"
],
"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[].data` | `array` | Yes | — | Status code indicating invitation was scheduled Maximum items: 200. |
| `result.data.portal_invite[].data[].details` | `object` | No | — | Record id of portal user |
| `result.data.portal_invite[].data[].details.id` | `string` | No | — | Record id of portal user Maximum length: 255. |
| `result.data.portal_invite[].data[].code` | `"SUCCESS" \| "CANNOT_PROCESS" \| "INVALID_DATA" \| "REQUIRED_PARAM_MISSING" \| "LICENSE_LIMIT_EXCEEDED" \| "NOT_REVIEWED" \| "NOT_APPROVED" \| "DUPLICATE_DATA"` | No | — | Status code of the invitation Allowed: `SUCCESS`, `CANNOT_PROCESS`, `INVALID_DATA`, `REQUIRED_PARAM_MISSING`, `LICENSE_LIMIT_EXCEEDED`, `NOT_REVIEWED`, `NOT_APPROVED`, `DUPLICATE_DATA`. |
| `result.data.portal_invite[].data[].message` | `string` | No | — | Message of the success/error reason Maximum length: 1000. |
| `result.data.portal_invite[].data[].status` | `"success" \| "error"` | No | — | Status of the invitation Allowed: `success`, `error`. |
| `result.data.portal_invite[].job_id` | `string` | Yes | — | Job ID to fetch the status of the portal user invitations Maximum length: 255. |
| `result.data.portal_invite[].status` | `"scheduled" \| "completed" \| "in_progress"` | Yes | — | Status of the response Allowed: `scheduled`, `completed`, `in_progress`. |
| `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": {
"data": {
"type": "array",
"description": "Status code indicating invitation was scheduled",
"maxItems": 200,
"items": {
"type": "object",
"description": "Error response for invitation",
"properties": {
"details": {
"type": "object",
"description": "Record id of portal user",
"properties": {
"id": {
"type": "string",
"description": "Record id of portal user",
"maxLength": 255
}
},
"additionalProperties": false
},
"code": {
"type": "string",
"description": "Status code of the invitation",
"enum": [
"SUCCESS",
"CANNOT_PROCESS",
"INVALID_DATA",
"REQUIRED_PARAM_MISSING",
"LICENSE_LIMIT_EXCEEDED",
"NOT_REVIEWED",
"NOT_APPROVED",
"DUPLICATE_DATA"
]
},
"message": {
"type": "string",
"description": "Message of the success/error reason",
"maxLength": 1000
},
"status": {
"type": "string",
"description": "Status of the invitation",
"enum": [
"success",
"error"
]
}
},
"additionalProperties": false
}
},
"job_id": {
"type": "string",
"description": "Job ID to fetch the status of the portal user invitations",
"maxLength": 255
},
"status": {
"type": "string",
"description": "Status of the response",
"enum": [
"scheduled",
"completed",
"in_progress"
]
}
},
"required": [
"data",
"job_id",
"status"
],
"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)