Zoho: Portal — portals update Portal

← Portals operations · Get started

Operation zoho.updateportal

Provider route: PUT /crm/v8/settings/portals/{portal}. 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"]["updatePortal"]>[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.updatePortal(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.update_portal(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: 60
body	object	Required within parent	Represents the request body schema for updating a portal, supporting name and SAML configuration updates. Additional keys: not allowed
body.portals	array	Required within parent	Specify the list of portal update objects. Only one portal is allowed per request. Maximum items: 100
body.portals[]	object	Each item	Represents the set of portal properties to update. Additional keys: not allowed
body.portals[].name	string	Optional	Specify the updated display name for the portal. The name must be between 6 and 30 characters. Maximum length: 30 Minimum length: 6
body.portals[].saml_configuration	object	Optional	Specify the SAML configuration to apply to the portal. Additional keys: not allowed
body.portals[].saml_configuration.active	boolean	Optional	Specify true to activate the SAML configuration for the portal. Possible values: true. One of: true
body.portals[].saml_configuration.login_url	string	Required within parent	Specify the SAML SSO login URL for the portal. Must begin with `https://www.`. Required when updating SAML configuration. Maximum length: 2048 Pattern: http[s]://www[.][a-z]{7}[.]com
body.portals[].saml_configuration.logout_url	string	Required within parent	Specify the SAML SSO logout URL for the portal. Must begin with `https://www.`. Required when updating SAML configuration. Maximum length: 2048 Pattern: http[s]://www[.][a-z]{7}[.]com
body.portals[].saml_configuration.public_key	string	Required within parent	Specify the SAML X.509 public key certificate. Required when updating SAML configuration. Maximum length: 5000

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

Policy, approvals and errors

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

Refused by default. This operation leaves the caller holding a credential (a SAML public key the caller sets, which lets whoever holds the matching private key sign users in to the portal; only when the request sets portals[].saml_configuration.public_key), so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider zoho and operation zoho.updateportal (or updatePortal). See Allow an operation that hands over a credential.

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