Calendar Model

PropertyTypeDescription
code

Required
StringCode Identifier for the calendar
name

Required
StringDisplay name of the calendar
image

Optional
StringCalendar image if available

Tag Model

PropertyTypeDescription
id

Required
UUID/GUIDIdentifier for the calendar tag
name

Required
StringDisplay name of the tag

Event Model

PropertyTypeDescription
id

Required
UUID/GUIDIdentifier for the calendar tag
name

Required
StringDisplay name of the tag
externalId

Optional
StringIdentifier that represents unique events to you
isExcluded

Optional
BooleanIndicates that this event is excluded from the subscriber's calendar.

EventDetail Model

PropertyTypeDescription
eventId

Required
StringA unique identifier for the event.
title

Required
StringSummary/Title of the event.
description

Required
StringText that will appear in the events Description field.
location

Optional
StringText that will appear in the event Location field.
timezone

Optional
StringA Windows timezone identifier. Indicates the timezone that an event occurs in.
start

Required
DateTime (ISO 8601)Date and time the event will start in Timezone that it is occurs in.
end

Required
DateTime (ISO 8601)Date and time the event will end in Timezone that it is occurs in.
allDayEvent

Optional
BooleanIndicated if the event runs all day.
notifyBefore

Optional
NumberIndicates how many minutes before the event the subscriber should be notified.

Error Model

PropertyTypeDescription
Code

Always present
StringRepresents the type of error.
Reason

Always present
StringExplains why the error occured.