Zoho: Invite portal users — portal Users get Scheduled Invite Users Info

← Portal users operations · Get started

Operation zoho.getscheduledinviteusersinfo

Provider route: GET /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"]["getScheduledInviteUsersInfo"]>[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.getScheduledInviteUsersInfo(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.get_scheduled_invite_users_info(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
query	object	Optional	Additional keys: not allowed
query.job_id	string	Optional	Represents the unique identifier of the scheduled invitation job. 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[].data	array	Required within parent	Represents the list of individual invitation results for this job batch. Maximum items: 200
portal_invite[].data[]	object	Each item	Represents the invitation result for a single portal invitation batch. Additional keys: not allowed
portal_invite[].data[].code	string	Optional	Represents the error code. Possible values: SUCCESS, CANNOT_PROCESS, INVALID_DATA, REQUIRED_PARAM_MISSING, LICENSE_LIMIT_EXCEEDED, NOT_REVIEWED, NOT_APPROVED, DUPLICATE_DATA. Known values: SUCCESS, CANNOT_PROCESS, INVALID_DATA, REQUIRED_PARAM_MISSING, LICENSE_LIMIT_EXCEEDED, NOT_REVIEWED, NOT_APPROVED, DUPLICATE_DATA
portal_invite[].data[].details	object	Optional	Represents additional details about the operation result. Additional keys: not allowed
portal_invite[].data[].details.id	string	Optional	Represents the unique identifier of the CRM record. Maximum length: 255
portal_invite[].data[].message	string	Optional	Represents the success or informational message for this operation result. Maximum length: 1000
portal_invite[].data[].status	string	Optional	Represents the status of the operation. Possible values: success, error. Known values: success, error
portal_invite[].job_id	string	Required within parent	Represents the unique identifier of the scheduled invitation job. Maximum length: 255
portal_invite[].status	string	Required within parent	Represents the status of the operation. Possible values: scheduled, completed, in_progress. Known values: scheduled, completed, in_progress

Policy, approvals and errors

SDK function policy ID: zoho.getscheduledinviteusersinfo. Catalog operation: getScheduledInviteUsersInfo. 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