Zoho: Holidays — holidays create Holidays

← Holidays operations · Get started

Operation zoho.createholidays

Provider route: POST /crm/v8/settings/holidays. 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["holidays"]["createHolidays"]>[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.createHolidays(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.holidays.create_holidays(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	Represents the request body schema for creating holidays. Additional keys: not allowed
body.holidays	array	Required within parent	Specify the list of holidays to create. At least one holiday object is required. Maximum items: 100 Minimum items: 1
body.holidays[]	object	Each item	Specify the details for a single holiday to create. Additional keys: not allowed
body.holidays[].date	string	Required within parent	Specify the date of the holiday in YYYY-MM-DD format. Format: date
body.holidays[].name	string	Required within parent	Specify the name of the holiday. Maximum length: 80 Minimum length: 1 Pattern: ^[^#%^&*]+$
body.holidays[].shift_hour	object	Optional	Specify the shift hour associated with this holiday. Required when the type field is set to shift_holiday. Additional keys: not allowed
body.holidays[].shift_hour.id	string	Required within parent	Specify the unique identifier of the shift hour. Use the [Get Shift Hours API](shift_hours.yaml#$.paths./settings/business_hours/shift_hours.get) to get the ID of the shift hour. Maximum length: 255 Pattern: ^[0-9]+$
body.holidays[].shift_hour.name	string	Required within parent	Specify the name of the shift hour. Maximum length: 255
body.holidays[].type	string	Required within parent	Specify the type of holiday. Possible values: business_holiday, shift_holiday. One of: business_holiday, shift_holiday
body.info	Model	Optional	Expand Holidays — holidays create Holidays — request body — body info

Referenced models: Holidays — holidays create Holidays — request body — body info

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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the response body the API returns after creating one or more holidays. Additional keys: not allowed
$ (anyOf 1).holidays	array	Required within parent	Contains the result for each holiday submitted in the create request. Maximum items: 100
$ (anyOf 1).holidays[]	object	Each item	Represents the creation result for a single holiday. Additional keys: not allowed
$ (anyOf 1).holidays[].code	string	Required within parent	Indicates the result code for this holiday creation. Possible values: SUCCESS. Known values: SUCCESS
$ (anyOf 1).holidays[].details	object	Required within parent	Contains the details of the created holiday record. Additional keys: not allowed
$ (anyOf 1).holidays[].details.id	string	Optional	Represents the unique identifier assigned to the created holiday. Maximum length: 255
$ (anyOf 1).holidays[].message	string	Required within parent	Describes the result of the holiday creation operation. Maximum length: 255
$ (anyOf 1).holidays[].status	string	Required within parent	Indicates the status of the holiday creation. Possible values: success. Known values: success
$ (anyOf 2)	Model	Alternative	Expand Holiday — response body

Referenced models: Holiday — response body

Schemas

Holiday — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response body the API returns after creating holidays. Additional keys: not allowed
holidays	array	Required within parent	Contains the result for each holiday included in the create request. Maximum items: 100
holidays[]	object	Each item	Represents the result for a single holiday creation request. Additional keys: not allowed
holidays[].code	string	Required within parent	Indicates the result code for the holiday operation. Possible values: SUCCESS. Known values: SUCCESS
holidays[].details	object	Required within parent	Contains the details of the processed holiday, including its unique identifier. Additional keys: not allowed
holidays[].details.id	string	Optional	Represents the unique identifier of the created holiday. Maximum length: 255
holidays[].message	string	Required within parent	Describes the result of the holiday creation operation. Maximum length: 255
holidays[].status	string	Required within parent	Indicates the status of the holiday creation operation. Possible values: success. Known values: success

Holidays — holidays create Holidays — request body — body info

Field	Type	Presence	Description and constraints
$	object	Root	Contains optional pagination context included in the request schema. Additional keys: not allowed
count	integer	Optional	Specify the total count of records. Format: int32
more_records	boolean	Optional	Specify whether more records are available on subsequent pages.
page	integer	Optional	Specify the page number to retrieve. Format: int32
per_page	integer	Optional	Specify the number of records to include per page. Format: int32

Policy, approvals and errors

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