Zoho: Get service preferences

← Service preference operations · Get started

Operation zoho.getservicepreference

Provider route: GET /crm/v8/settings/service_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["servicePreference"]["getServicePreference"]>[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.servicePreference.getServicePreference(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.service_preference.get_service_preference(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

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 response wrapper that contains the service preference settings of the organization. Additional keys: not allowed
service_preferences	object	Required within parent	Represents the service preference settings configured for the organization. Additional keys: not allowed
service_preferences.job_sheet_enabled	boolean	Required within parent	Denotes whether the job sheet is enabled for the organization. When the job sheet is enabled, a job sheet can be generated for a service appointment once the appointment is marked complete. Possible values: - true: The job sheet is enabled for the organization. This is the default value. - false: The job sheet is disabled for the organization.

Policy, approvals and errors

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