Zoho: A specific holiday — holidays update Holiday
Zoho holidays.updateHoliday: arguments, response, policy and SDK examples.
← Holidays operations · Get started
Operation zoho.updateholiday
Provider route: PUT /crm/v8/settings/holidays/{holidayId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["holidays"]["updateHoliday"]>[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.holidays.updateHoliday(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.holidays.update_holiday(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.holidayId | string | Required within parent | The Holiday id of the object. Maximum length: 30 Minimum length: 1 Pattern: ^[0-9]+$ |
body | object | Required within parent | Represents the request body schema for updating a single holiday. Additional keys: not allowed |
body.holidays | array | Optional | Specify the updated details for the holiday. Maximum items: 1 Minimum items: 1 |
body.holidays[] | object | Each item | Specify the fields to update for the holiday. Additional keys: not allowed |
body.holidays[].date | string or null | Optional | Specify the new date for the holiday in YYYY-MM-DD format. Format: date |
body.holidays[].name | string or null | Optional | Specify the new name for the holiday. Maximum length: 80 Minimum length: 1 Pattern: ^[^#%^&*]+$ |
Response
Section titled “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 body the API returns after updating the holiday. Additional keys: not allowed |
holidays | array | Required within parent | Contains the result for the updated holiday. Maximum items: 100 |
holidays[] | object | Each item | Represents the update result for the holiday record. Additional keys: not allowed |
holidays[].code | string | Required within parent | Indicates the result code for the holiday update. Possible values: SUCCESS. Known values: SUCCESS |
holidays[].details | object | Required within parent | Contains the details of the updated holiday, including its unique identifier. Additional keys: not allowed |
holidays[].details.id | string | Optional | Represents the unique identifier of the updated holiday. Maximum length: 255 |
holidays[].message | string | Required within parent | Describes the result of the holiday update operation. Maximum length: 255 |
holidays[].status | string | Required within parent | Indicates the status of the holiday update. Possible values: success. Known values: success |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.updateholiday. Catalog operation: updateHoliday. 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.