Zoho: Portal User Status

← Portal users operations · Get started

Operation zoho.changeportalusersstatusbulk

Provider route: PUT /crm/v8/settings/portals/{portal}/user_type/{userType}/users/actions/change_status. 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"]["changePortalUsersStatusBulk"]>[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.changePortalUsersStatusBulk(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.change_portal_users_status_bulk(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.portal	string	Required within parent	Represents the unique name of the portal. Maximum length: 255
path.userType	integer	Required within parent	Represents the unique numeric identifier of the portal user type. Format: int64 Maximum length: 255
body	object	Optional	Request body for changing status of portal users Additional keys: not allowed
body.change_status	array	Required within parent	Represents the list of portal user status change results. Contains one result object per requested status change. Maximum items: 100
body.change_status[]	object	Each item	Represents the status change result for a single portal user. Additional keys: not allowed
body.change_status[].users	array	Required within parent	Represents the list of portal user objects. Maximum items: 100
body.change_status[].users[]	object	Each item	Represents the status change result for a single portal user. Additional keys: not allowed
body.change_status[].users[].active	boolean	Required within parent	Indicates whether the portal user is currently active. Possible values: true, false.
body.change_status[].users[].personality_id	string	Required within parent	Specify the unique identifier of the portal user record. 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 containing the status change result for the portal user. Additional keys: not allowed
change_status	array	Required within parent	Represents the list of portal user status change results. Contains one result object per requested status change. Maximum items: 100
change_status[]	object	Each item	Represents the status change result for a single portal user. Additional keys: not allowed
change_status[].code	string	Required within parent	Represents the error code. Possible values: SCHEDULED. Known values: SCHEDULED
change_status[].details	object	Required within parent	Represents additional details about the operation result. Additional keys: not allowed
change_status[].details.job_id	string	Required within parent	Represents the unique identifier of the scheduled invitation job. Maximum length: 255
change_status[].message	string	Required within parent	Represents the success or informational message for this operation result. Maximum length: 1000
change_status[].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.changeportalusersstatusbulk. Catalog operation: changePortalUsersStatusBulk. 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