Zoho: Currency

← Currencies operations · Get started

Operation zoho.updatecurrencybyid

Provider route: PUT /crm/v8/org/currencies/{currency}. 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["currencies"]["updateCurrencyById"]>[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.currencies.updateCurrencyById(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.currencies.update_currency_by_id(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.currency	string	Required within parent	Maximum length: 255
body	object	Required within parent	Payload for updating a specific currency by ID. Additional keys: not allowed
body.currencies	array	Required within parent	List of currencies to update (single-element array expected). Maximum items: 100
body.currencies[]	object	Each item	Currency object containing update fields. Additional keys: not allowed
body.currencies[].exchange_rate	string	Optional	Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to nine digits and nine decimal places. Example: 123456789.123456789. Maximum length: 18 Pattern: ^[0-9]{1,9}(.[0-9]{1,9})?$
body.currencies[].exchange_rate_auto_update	boolean	Optional	Indicates whether the currency has the automated exchange rate option enabled or not.
body.currencies[].format	object	Optional	Configuration for currency formatting rules. Additional keys: not allowed
body.currencies[].format.decimal_places	string	Optional	Represents the number of decimal places allowed for the currency. It can be 0, 2, and 3. One of: 0, 2, 3, 4, 5, 6
body.currencies[].format.decimal_separator	string	Optional	The decimal separator separates the integer part of the currency from its fractional part. It can be a Period or Comma, depending on the currency. One of: Comma, Period
body.currencies[].format.numeral_system	string	Optional	Defines the numbering system used for digit grouping. Default: International One of: Indian, International
body.currencies[].format.thousand_separator	string	Optional	The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency. One of: Comma, Period, Space
body.currencies[].is_active	boolean	Optional	Indicates whether the currency is active and available for use.

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 updated currency data. Additional keys: not allowed
currencies	array	Required within parent	List of updated currency responses. Maximum items: 100
currencies[]	object	Each item	JSON object for an update operation on an individual currency, including status and updated currency details. Additional keys: not allowed
currencies[].code	string	Required within parent	Specifies the response code Maximum length: 255
currencies[].details	object	Required within parent	Detailed information about the currency update Additional keys: not allowed
currencies[].details.id	string	Required within parent	The unique identifier of the currency. Format: int64 Maximum length: 50
currencies[].message	string	Required within parent	Indicates the response message. Maximum length: 255
currencies[].status	string	Required within parent	Represents the status of the response. Known values: success

Policy, approvals and errors

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