Zoho: Invite portal users — portal Users invite Users

← Portal users operations · Get started

Operation zoho.inviteusers

Provider route: POST /crm/v8/{module}/actions/portal_invite. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["portalUsers"]["inviteUsers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.portalUsers.inviteUsers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.portal_users.invite_users(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.module	string	Required within parent	Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores. Maximum length: 255
body	object	Required within parent	Request body for inviting portal users Additional keys: not allowed
body.portal_invite	array	Required within parent	Specify the list of portal invitation objects. Each object must contain a data array of user records to invite. Maximum items: 100
body.portal_invite[]	object	Each item	Specify the invitation data for a single portal invitation batch. Additional keys: not allowed
body.portal_invite[].data	array	Required within parent	Specify the list of user records to include in this invitation batch. Maximum items: 100
body.portal_invite[].data[]	object	Each item	Specify the invitation data for a single portal invitation batch. Additional keys: not allowed
body.portal_invite[].data[].id	string	Required within parent	Specify the unique identifier of the CRM record to invite as a portal user. Format: int64 Maximum length: 255
body.portal_invite[].data[].language	string or null	Optional	Specify the locale code of the language for the invitation email. Omit or set to null to use the portal’s default language. One of: , 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, null
body.portal_invite[].data[].type	string	Required within parent	Specify the invitation action type. Possible values: invite (new invitation), reinvite (re-send invitation). One of: reinvite, invite
body.portal_invite[].data[].user_type_id	string	Required within parent	Specify the unique identifier of the portal user type to assign. Refer to the [Get Portal User Types](https://www.zoho.com/crm/developer/docs/api/v8/get-user-types.html) resource for valid values. Format: int64 Maximum length: 255

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Response for portal user invitation requests Additional keys: not allowed
portal_invite	array	Required within parent	Represents the list of portal invitation response objects. Contains one object per invitation batch. Maximum items: 100
portal_invite[]	object	Each item	Represents the invitation result for a single portal invitation batch. Additional keys: not allowed
portal_invite[].code	string	Required within parent	Represents the error code. Possible values: SCHEDULED. Known values: SCHEDULED
portal_invite[].details	object	Required within parent	Represents additional details about the operation result. Additional keys: not allowed
portal_invite[].details.job_id	string	Required within parent	Represents the unique identifier of the scheduled invitation job. Maximum length: 255
portal_invite[].message	string	Required within parent	Represents the success or informational message for this operation result. Maximum length: 1000
portal_invite[].status	string	Required within parent	Represents the status of the operation. Possible values: success. Known values: success

Policy, approvals and errors

SDK function policy ID: zoho.inviteusers. Catalog operation: inviteUsers. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source