Calendar Events: Overview of Methods

Calendar events are scheduled activities or meetings. They contain information about the date, time, location, and participants of the event. Events help users manage their schedules and remind them of upcoming activities and meetings.

Quick navigation: all methods and events

User documentation: how to create an event in the calendar

Linking Calendar Events with Other ObjectsLinking Calendar Events with Other Objects

User. An event is linked to a user by the calendar owner's ID ownerId for the user calendar type. If the event is a meeting with participants is_meeting = 'Y', it is additionally linked to the event organizer host and the participants attendees. You can obtain the user ID using the user.get method.

Group. An event is linked to a group by the calendar owner's ID ownerId for the group calendar type. The ID can be obtained using the create new group method or the get list of groups method.

CRM Objects. You can link CRM objects to an event: companies, contacts, leads, and deals. To link objects, list their IDs with prefixes in the crm_fields parameter. For example, C_3 for a contact with id = 3. You can obtain the ID using the create new CRM item method or the get list of items method.

List of EventsList of Events

You can obtain a list of calendar events using two methods:

• calendar.event.get — returns a list of any events, past and future, for the specified period
• calendar.event.get.nearest — returns a list of only future events for the specified number of days

User Participation in an EventUser Participation in an Event

The user decides whether to participate in the event or not. The decision is recorded in the participation status and can have the following values:

• Y — accepted
• N — declined
• Q — invited but not yet responded

You can find out the current user's participation status in the event using the calendar.meeting.status.get method. To set the status, use the calendar.meeting.status.set method.

The calendar.accessibility.get method retrieves the availability of users from the list.

Overview of Methods and EventsOverview of Methods and Events

Scope: calendar

Who can execute the method: any user