Zoho: Call Preferences — call Preferences update Call Preferences

← Call preferences operations · Get started

Operation zoho.updatecallpreferences

Provider route: PUT /crm/v8/settings/call_preferences. 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["callPreferences"]["updateCallPreferences"]>[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.callPreferences.updateCallPreferences(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.call_preferences.update_call_preferences(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	Specify the new visibility setting for the From Number field, the To Number field, or both. Additional keys: not allowed
body.call_preferences	object	Optional	Specify the new visibility setting for one or both Call Preferences. Omit a preference from the object to leave its current setting unchanged. Additional keys: not allowed
body.call_preferences.show_from_number	boolean	Optional	Specify whether the From Number field must appear on records in the Calls module. Possible values: true - Enable the From Number field on Call records. false - Disable the From Number field and hide it from Call records.
body.call_preferences.show_to_number	boolean	Optional	Specify whether the To Number field must appear on records in the Calls module. Possible values: true - Enable the To Number field on Call records. false - Disable the To Number field and hide it from Call records.

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	Returned when the Call Preferences are successfully updated. Contains a call_preferences object that confirms the update outcome. Additional keys: not allowed
call_preferences	object	Optional	Contains the update result for the Call Preferences configuration, including the result code, status, and message. Additional keys: not allowed
call_preferences.code	string	Required within parent	Represents the result code of the update action. Possible values: SUCCESS - Reports successful update of the Call Preferences configuration. Known values: SUCCESS
call_preferences.details	object	Required within parent	Contains additional information about the update action. This object remains empty for a successful Call Preferences update. Additional keys: not allowed
call_preferences.message	string	Required within parent	Describes the update result in plain text so that it can be displayed to the developer. Maximum length: 255
call_preferences.status	string	Required within parent	Indicates the outcome of the request. Possible values: success - The request completed successfully. Known values: success

Policy, approvals and errors

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