---
schema_version: "1"
id: f72e612998d481fa713bfb38fee95af278e8d8351227fe98046e1329adb41a1f
title: CalendarView
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_calendarview.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_calendarview.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ef801cc257979fcb875bae82558f5fe4e07770c8dadc8dc323a8a2e09d3b45da
description: These calendars can be created and assigned to users other than the creator. Available calendars include object, shared, public, resource, and user list calendars. Object calendars represent a calendar based on a Salesforce object, either standard or custom. This object is available in API version 51.0 and later.
---
# CalendarView

These calendars can be created and assigned to users other than the creator. Available calendars include object, shared, public, resource, and user list calendars. Object calendars represent a calendar based on a Salesforce object, either standard or custom. This object is available in API version 51.0 and later.

## Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

## Special Access Rules

All fields and entities referenced by field values must be accessible by the CalendarView creator even if the creator isn’t the CalendarView owner.

## Fields

<table class="featureTable sort_table" summary="">


          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d329107e107">Field</th>

              <th class="featureTableHeader  " id="d329107e110">Details</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">Color</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Represents the color used in the background for records displayed
                    in a user’s calendar view within the user interface.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">CurrencyIsoCode</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Nillable, Restricted
                    picklist, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Available only for organizations with the multicurrency feature
                    enabled. Contains the ISO code for any currency allowed by the
                    organization. </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">DateHandlingType</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Defaulted on create, Filter, Group, Nillable, Restricted picklist,
                    Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Determined by the data type of the
                    <span class="keyword parmname">StartField</span>. Valid values include:
                  </dd>


                </dl>

                <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Date</samp></li>

                  <li class="li"><samp class="codeph nolang">Datetime</samp></li>

                </ul>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">DisplayField</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Represents the <span class="keyword parmname">SobjectType</span> field used as the
                    subject for records displayed in a user’s calendar view within the
                    user interface.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">EndField</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">An optional field that represents the sObjectType field used as
                    the end time for records displayed in a user’s calendar view within
                    the user interface. Must be a date or dateTime field that matches
                    the type in <span class="keyword parmname">StartField</span>.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">FillPattern</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Represents the pattern displayed as the background for records
                    displayed in a user’s calendar view within the user interface.
                    Valid values include: <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">verticalStripes</samp></li>

                      <li class="li"><samp class="codeph nolang">ascDiagonalStripes</samp></li>

                      <li class="li"><samp class="codeph nolang">descDiagonalStripes</samp></li>

                    </ul>
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">IsDisplayed</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">boolean</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Defines whether users can see a calendar’s records in their
                    calendar view in the user interface. When <samp class="codeph nolang">true</samp>, records are visible in the
                    user’s calendar view. When <samp class="codeph nolang">false</samp>, records are hidden from the user’s calendar
                    view. The default is <samp class="codeph nolang">true</samp>.
                    <span class="keyword parmname">IsDisplayed</span> can be <samp class="codeph nolang">true</samp> for up to 50 calendars.
                  </dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">ListViewFilterId</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Nillable, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">References the ListView used to filter records represented by the
                    CalendarView. ListView must have the same sObjectType. If no
                    <span class="keyword parmname">ListViewFilterId</span> is defined, the calendar
                    displays only records with the same owner as the CalendarView.
                  </dd>

                  <dd class="dd">This is a relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">ListViewFilter</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">ListView</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">Name</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, idLookup, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">A user-provided name that identifies the calendar. This isn’t an
                    enumerated field; it can be any string to a maximum length of 80
                    characters.</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">OwnerId</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Represents the owner of the CalendarView.</dd>

                  <dd class="dd">This is a polymorphic relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">Owner</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">Group, User</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">PublisherId</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>


                </dl>

                <dl class="dl detailList">

                  <dd class="dd">reference</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Defaulted on create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Represents the user, user list, public, or resource calendar from
                    where event data is populated.</dd>

                  <dd class="dd">This is a polymorphic relationship field.</dd>



                  <dt class="dt dlterm">Relationship Name</dt>

                  <dd class="dd">Publisher</dd>



                  <dt class="dt dlterm">Relationship Type</dt>

                  <dd class="dd">Lookup</dd>



                  <dt class="dt dlterm">Refers To</dt>

                  <dd class="dd">Calendar, ListView, User</dd>


                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">SobjectType</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">picklist</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Restricted picklist, Sort</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">The type of standard or custom Salesforce object that is used to
                    create records for the CalendarView. Use the API name of the
                    desired <span class="keyword parmname">SobjectType</span>.</dd>



                </dl>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d329107e107" data-title="Field"><span class="keyword parmname">StartField</span></td>

              <td class="entry" headers="d329107e110" data-title="Details">
                <dl class="dl detailList">

                  <dt class="dt dlterm">Type</dt>

                  <dd class="dd">string</dd>



                  <dt class="dt dlterm">Properties</dt>

                  <dd class="dd">Create, Filter, Group, Sort, Update</dd>



                  <dt class="dt dlterm">Description</dt>

                  <dd class="dd">Represents the <span class="keyword parmname">SobjectType</span> field used as the
                    start time for records displayed in a user’s calendar view within
                    the user interface. Must be a date or dateTime field type.</dd>


                </dl>

              </td>

            </tr>

          </tbody>

        </table>

## Usage

To distribute a CalendarView to multiple users, IDs can be pulled from a group, user list, or profile. For this example, a CalendarView based on opportunity close dates is being distributed to a sales team in a public group, Sales Group:

Group userGroup = \[SELECT Id FROM Group WHERE Name = 'Sales Group' LIMIT 1\];
List<Id> groupId = new List<Id>();
groupId.add(userGroup.id);
List<GroupMember> groupMembers = \[SELECT UserOrGroupId FROM GroupMember
   WHERE GroupId IN: groupId\];

List<CalendarView> calendarViews = new List<CalendarView>();
for (GroupMember groupMember : groupMembers) {
   CalendarView calendarView = new CalendarView(name = 'Opportunity Close Dates’,
    SobjectType = 'Opportunity', StartField = 'CloseDate', DisplayField =
    'Name', OwnerId = groupMember.UserOrGroupId);
   calendarViews.add(calendarView);
}
insert calendarViews;

## Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

[CalendarViewChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0)

Change events are available for the object.