Zoho: Data Sharing Settings — data Sharing update Data Sharing

← Data sharing operations · Get started

Operation zoho.updatedatasharing

Provider route: PUT /crm/v8/settings/data_sharing. 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["dataSharing"]["updateDataSharing"]>[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.dataSharing.updateDataSharing(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.data_sharing.update_data_sharing(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Optional	Root request body for updating data sharing settings. Additional keys: not allowed
body.data_sharing	array	Required within parent	Contains the details of your organization’s default data-sharing permissions for modules. Maximum items: 100
body.data_sharing[]	object	Each item	Object containing the module and its data-sharing permission details. Additional keys: not allowed
body.data_sharing[].module	object	Required within parent	Contains the API name and ID of the module for which you want to change user access. Mandatory. Additional keys: not allowed
body.data_sharing[].module.api_name	string	Optional	Represents the API name of the module. Maximum length: 100
body.data_sharing[].module.id	string	Required within parent	Represents the unique ID of the module. Format: int64 Maximum length: 19
body.data_sharing[].share_type	string	Required within parent	Represents the access level you want to set for the module. Possible values: private - Only the record owner and their superior can view the records in the module. public_read_only - Users can view others’ records but cannot modify or delete them. public_read_write - Users can view and modify others’ records but cannot delete them. public - Users can view, modify, and delete others’ records. One of: private, public_read_write, public, public_read_only

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 object containing the update status for data sharing settings. Additional keys: not allowed
data_sharing	array	Required within parent	Array containing the update status for each module’s data sharing setting. Maximum items: 100
data_sharing[]	object	Each item	Object containing the update status details for a module’s data sharing setting. Additional keys: not allowed
data_sharing[].code	string	Required within parent	The status code of the operation. Known values: SUCCESS
data_sharing[].details	object	Required within parent	Object containing additional details about the updated module. Additional keys: not allowed
data_sharing[].details.module	string	Optional	The API name of the module whose data sharing setting was updated. Maximum length: 100
data_sharing[].message	string	Required within parent	A message describing the result of the operation. Known values: data sharing settings updated successfully
data_sharing[].status	string	Required within parent	Indicates the operation status. Known values: success

Policy, approvals and errors

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