Represents a period of time during which your customer support team is unavailable. Business hours and escalation rules associated with business hours are suspended during any holidays with which they are affiliated.
| Field | Field Type | Field Properties | Description |
|---|---|---|---|
| ActivityDate | date | Create | If the Holiday IsAllDay flag is set to true (indicating that it is an all-day holiday), then the holiday due date information is contained in the ActivityDate field. This field is a date field with a timestamp that is always set to midnight in the Coordinated Universal Time (UTC) time zone. The timestamp is not relevant, and you should not attempt to alter it to account for any time zone differences. |
| Description | string | Create | Text description of the holiday. |
| EndTimeInMinutes | int | Create | The end time of the holiday in minutes. |
| IsAllDay | boolean | Create |
Indicates whether the duration of the holiday is all day (true) or not (false). |
| IsRecurrence | boolean | Create | Indicates whether the holiday is scheduled to repeat itself (true) or only occurs once (false). This is a read only field on update, but not on create. If this field value is true, then any recurrence fields associated with the given recurrence type must be populated. |
| Name | string | Create |
The name of the holiday. |
| RecurrenceDayOfMonth | int | Create | The day of the month on which the holiday repeats. |
| RecurrenceDayOfWeekMask | int | Create | The day or days of the week on which the holiday repeats.
This field contains a bitmask. For each day of the week, the values
are as follows:
|
| RecurrenceEndDateOnly | date | Create | The last date on which the holiday repeats. For multiday recurring events, this is the day on which the last occurrence starts. |
| RecurrenceInstance | picklist | Create | The frequency of the recurring holiday. For example, “2nd” or “3rd.” |
| RecurrenceInterval | int | Create | The interval between recurring holidays. |
| RecurrenceMonthOfYear | picklist | Create | The month of the year on which the event repeats. |
| RecurrenceStartDate | date | Create | The date when the recurring holiday begins. Must be a date and time before RecurrenceEndDateOnly. |
| RecurrenceType | picklist | Create | Indicates how often the holiday repeats. For example, daily, weekly, or every Nth month (where “Nth” is defined in RecurrenceInstance). |
| StartTimeInMinutes | int | Create | The start time of the holiday in minutes. |