Holiday

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.

Supported Calls

create(), update(), delete(), query(), retrieve()

Special Access Rules

Customer Portal users cannot access this object.

Fields

Field Field Type Field Properties Description
ActivityDate date Create

Filter

Nillable

Update

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

Filter

Nillable

Update

Text description of the holiday.
EndTimeInMinutes int Create

Filter

Nillable

Update

The end time of the holiday in minutes.
IsAllDay boolean Create

Defaulted on create

Filter

Update

Indicates whether the duration of the holiday is all day (true) or not (false).

IsRecurrence boolean Create

Defaulted on create

Filter

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

Filter

Update

The name of the holiday.

RecurrenceDayOfMonth int Create

Filter

Nillable

Update

The day of the month on which the holiday repeats.
RecurrenceDayOfWeekMask int Create

Filter

Nillable

Update

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:
  • Sunday = 1
  • Monday = 2
  • Tuesday = 4
  • Wednesday = 8
  • Thursday = 16
  • Friday = 32
  • Saturday = 64
Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 4 + 16 = 20.
RecurrenceEndDateOnly date Create

Filter

Nillable

Update

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

Filter

Nillable

Restricted picklist

Update

The frequency of the recurring holiday. For example, “2nd” or “3rd.”
RecurrenceInterval int Create

Filter

Nillable

Update

The interval between recurring holidays.
RecurrenceMonthOfYear picklist Create

Filter

Nillable

Restricted picklist

Update

The month of the year on which the event repeats.
RecurrenceStartDate date Create

Filter

Nillable

Update

The date when the recurring holiday begins. Must be a date and time before RecurrenceEndDateOnly.
RecurrenceType picklist Create

Filter

Nillable

Restricted picklist

Update

Indicates how often the holiday repeats. For example, daily, weekly, or every Nth month (where “Nth” is defined in RecurrenceInstance).
StartTimeInMinutes int Create

Filter

Nillable

Update

The start time of the holiday in minutes.

Usage

Use this object to view and update holidays, which specify dates and times at which associated business hours and escalation rules are suspended. For more information on holidays, see “Setting Holidays” in the Salesforce.com online help.

© Copyright 2000-2009 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.