Zoho CRM: Portal Users Single Invite User

Invite one Zoho CRM record, such as a contact, to a portal as a user.

Tool ID: zoho_crm_portal_users_single_invite_user

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

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

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 returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "portal_invite": [
      {
        "code": "SUCCESS",
        "details": {
          "record_id": "record_123"
        }
      }
    ]
  }
}

Use deepline describe 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`.

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).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation