Events are used to schedule times on your calendar. They work pretty much like any other calendar (e.g. Outlook or Google Calendar) except that they can be linked directly to contacts/companies in your CRM.
Unlike tasks, events are automatically considered to be "completed" whenever they end. Because of this, events are best for things that have specific start and end times whereas tasks are better for things you will handle sometime during the day, but that aren't specifically schedule.
This function will create an event on your calendar or the calendar of another user you have permission to edit.
The name of the event. This is displayed with the event on the calendar.
The start date and time of the event. For all-day events,
the time will be ignored. If included, the timezone set for the StartDate
will be used as the timezone for the event.
The end date and time of the event. For all-day events, the time will be ignored.
Whether or not this is an all day event.
The location of the event.
A description of the event.
The calendar that this event will be attached to. Only pass in if you are attending the event; if no calendar is passed in, we will default to your primary calendar.
An array of attendees with their Id, their corresponding attendance status and IsUser which denotes whether the attendee is a User, otherwise the attendee is a contact.
object
with the following fields:Is true if this attendee is a user, else attendee is a contact
UserId or ContactId of this attendee
IsAttending
, Maybe
, NotAttending
,
Whether this contact is attending the event.
Whether or not this is a repeating (recurring) event on your calendar. If true
, a RecurrenceRule
will also need to be specified.
The rule to determine how frequently this event recurs. This is required if you are creating a recurring event. For more information on recurrence rules, click here.
The last date this recurring event should appear on your calendar. Not to be confused with EndDate
which sets when a single instance of an event will end.
This function will update an existing event.
The id of the event to update.
The name of the event. This is displayed with the event on the calendar.
The start date and time of the event. For all-day events, the time will be ignored.
The end date and time of the event. For all-day events, the time will be ignored.
Whether or not this is an all day event.
The location of the event.
A description of the event.
The calendar that this event will be attached to.
An array of attendees with their Id, their corresponding attendance status and IsUser which denotes whether the attendee is a User, otherwise the attendee is a contact.
object
with the following fields:Is true if this attendee is a user, else attendee is a contact
UserId or ContactId of this attendee
IsAttending
, Maybe
, NotAttending
,
Whether this contact is attending the event.
The rule to determine how frequently this event recurs. This is required if you are creating a recurring event. For more information on recurrence rules, click here.
The last date this recurring event should appear on your calendar. Not to be confused with EndDate
which sets when a single instance of an event will end.
This function will delete an event from your calendar, as well as the calendars of any other attending user. If you want to remove yourself from an event,
use EditEvent
instead.
The Id of the event you want to delete.
This function gets a single event from the calendar based on the Id of the event. If you don't already know the
EventId
, you can find events using GetEvents
or GetEventsAttachedToContact
.
The Id of the event you want to get.
This function will get all events between a date range; will return all visible events by default, but can be filtered by calendar, contact, or user.
Ascending
, Descending
Whether the results should be sorted in ascending or descending order.
The start date (inclusive) of the range of events you want to retrieve.
The end date (inclusive) of the range of events you want to retrieve.
If you'd like to only see events assigned to specific users, pass their UserIds into this field and we'll filter the results to only show those users' events.
If you specify this parameter, only events matching the given CalendarIds will be returned. Only works for your own calendars.
If you specify this parameter, only events attached to this contact will be returned. Alternatively,
you can call GetEventsAttachedToContact
to get the same results. If you specify this parameter, all events attached to this contact will be returned and other filters will be ignored.
How many results should be returned from a single API call? The max value is 10,000. If you need to return
more results, call this API function again, but increment the Page
parameter.
If there are more results than MaxNumberOfResults
, you can call this function again with an incremented
Page
value to get the next page of results. For example, if there are 700 results, but you're only requesting
500 at a time, you could call this function with Page=2 to get the remaining 200 results.
Returns all events for a contact.
The contact to get events for.
How many results should be returned from a single API call? The max value is 10,000. If you need to return
more results, call this API function again, but increment the Page
parameter.
If there are more results than MaxNumberOfResults
, you can call this function again with an incremented
Page
value to get the next page of results. For example, if there are 700 results, but you're only requesting
500 at a time, you could call this function with Page=2 to get the remaining 200 results.