Zoho: Portal — portals create Portal

← Portals operations · Get started

Operation zoho.createportal

Provider route: POST /crm/v8/settings/portals. 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["portals"]["createPortal"]>[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.portals.createPortal(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.portals.create_portal(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent	Represents the request body schema for creating a portal, containing the portal name. Additional keys: not allowed
body.portals	array	Required within parent	Specify the list of portals to create. Only one portal is allowed per request. Maximum items: 100
body.portals[]	object	Each item	Represents the configuration for a new portal. Additional keys: not allowed
body.portals[].name	string	Required within parent	Specify the display name for the portal. The name must be between 6 and 30 characters. Maximum length: 30 Minimum length: 6

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	Represents the 200 response schema for a successful portal creation, including the portal name and result code. Additional keys: not allowed
portals	array	Required within parent	Represents the list of created portals. Maximum items: 100
portals[]	object	Each item	Represents the creation result for a single portal. Additional keys: not allowed
portals[].code	string	Required within parent	Represents the result code for the portal creation. Possible values: SUCCESS - the portal creation completed successfully. Known values: SUCCESS
portals[].details	object	Required within parent	Represents the details of the created portal. Additional keys: not allowed
portals[].details.name	string	Required within parent	Represents the name of the created portal. Maximum length: 30
portals[].message	string	Required within parent	Represents the confirmation message for the portal creation. Maximum length: 255
portals[].status	string	Required within parent	Represents the overall status of the portal creation. Possible values: success - the operation completed successfully. Known values: success

Policy, approvals and errors

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