Zoho: Profile — profiles patch Profile

← Profiles operations · Get started

Operation zoho.patchprofile

Provider route: PATCH /crm/v8/settings/profiles/{id}. 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["profiles"]["patchProfile"]>[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.profiles.patchProfile(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.profiles.patch_profile(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.id	string	Required within parent	Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
body	object	Required within parent	Request body for the partial profile update operation. Additional keys: not allowed
body.profiles	array	Required within parent	Specify a single-item JSON array containing the profile update payload. Maximum items: 1
body.profiles[]	object	Each item	Partial update payload for the profile. Minimum fields: 1 Additional keys: not allowed
body.profiles[].description	string or null	Optional	Specify the new text description for the profile. Maximum length: 250
body.profiles[].name	string or null	Optional	Specify the new name for the profile (up to 50 characters). Maximum length: 50
body.profiles[].permissions_details	array	Optional	List of permission toggle entries to apply (up to 2000). Maximum items: 2000
body.profiles[].permissions_details[]	Model	Each item	Expand Specific Profile — request body — body profiles item permissions details item

Referenced models: Specific Profile — request body — body profiles item permissions details item

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	Successful response for the partial profile update operation. Additional keys: not allowed
profiles	array	Required within parent	Update results for the profile (up to 50 entries). Maximum items: 50
profiles[]	object	Each item	Result for the partial profile update operation. Additional keys: not allowed
profiles[].code	string	Required within parent	Operation result code. Possible values: `SUCCESS`. Known values: SUCCESS
profiles[].details	object	Required within parent	Details object containing the ID of the updated profile. Additional keys: not allowed
profiles[].details.id	string	Required within parent	Unique identifier of the updated profile. Format: int64
profiles[].message	string	Required within parent	Human-readable message confirming the update result. Maximum length: 500
profiles[].status	string	Required within parent	Status of the operation. Possible values: success. Known values: success

Schemas

Specific Profile — request body — body profiles item permissions details item

Field	Type	Presence	Description and constraints
$	object	Root	A single permission toggle entry specifying the permission ID and its desired enabled state. Additional keys: not allowed
enabled	boolean	Required within parent	Desired enabled state for the permission. **Possible values:** `true` to enable, `false` to disable.
id	string	Required within parent	The unique identifier of the permission. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Policy, approvals and errors

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