API docs by Redocly

calendar API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the calendar stack.

SchedulerService

SchedulerService_GetAppointment

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "appointment": {
    }
}

SchedulerService_CancelAppointments

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

SchedulerService_CreateAppointments

Request Body schema: application/json
required
objectId
required
string
required
Array of objects (schedulerAppointmentSlotInput)

Responses

Request samples

Content type
application/json
{
  • "objectId": "string",
  • "slots": [
    ]
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

SchedulerService_CreateTokenForRequestingAppointments

Request Body schema: application/json
required
contactId
required
string

The contactId of the person who is requested to create the appointments.

objectId
required
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

SchedulerService_GetReminderConfig

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "hoursBeforeAppointment": 0,
  • "mailboxId": "string"
}

SchedulerService_GetTokenForRegistering

path Parameters
objectId
required
string

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

SchedulerService_ListAppointmentsByObjectId

Request Body schema: application/json
required
objectId
required
string

Responses

Request samples

Content type
application/json
{
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

SchedulerService_GetAvailableSlots

path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "availableSlots": [
    ],
  • "objectId": "string"
}

SchedulerService_ListAppointmentsByToken

path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

SchedulerService_SubmitRequestedAppointments

Request Body schema: application/json
required
required
Array of objects (schedulerAppointmentSlotInput)
token
required
string

Responses

Request samples

Content type
application/json
{
  • "slots": [
    ],
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

SchedulerService_SubmitSlotSelection

Request Body schema: application/json
required
appointmentId
required
string
email
required
string
firstName
required
string
lastName
required
string
phone
required
string
token
required
string

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "string",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phone": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{ }

SchedulerService_SetReminderConfig

Request Body schema: application/json
required
accountId
required
string <int64>
hoursBeforeAppointment
required
integer <int32>

Number of hours before the appointment when the reminder should be sent

mailboxId
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "hoursBeforeAppointment": 0,
  • "mailboxId": "string"
}

Response samples

Content type
application/json
{ }

SchedulerService_UnregisterParticipant

Request Body schema: application/json
required
appointmentId
required
string
participantId
required
string

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "string",
  • "participantId": "string"
}

Response samples

Content type
application/json
{ }

ReminderService

ReminderService_CountDueReminders

path Parameters
ownerId
required
string <int64>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

ReminderService_CountUndoneReminders

path Parameters
ownerId
required
string <int64>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Create

Request Body schema: application/json
required
activity
required
string (reminderReminderActivity)
Default: "UNDEFINED_REMINDER_ACTIVITY"
Enum: "UNDEFINED_REMINDER_ACTIVITY" "CALL_REMINDER_ACTIVITY" "MAIL_REMINDER_ACTIVITY" "POST_REMINDER_ACTIVITY" "TODO_REMINDER_ACTIVITY" "TO_DISCUSS_REMINDER_ACTIVITY" "TO_READ_THROUGH_REMINDER_ACTIVITY"
contactId
required
string
date
required
string <int64> (UNIX timestamp in seconds)
done
required
string <int64> (UNIX timestamp in seconds when the reminder was set to done. 0=not done)
employeeUserId
required
string
ownerId
required
string <int64>
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"
referenceIds
required
Array of strings (IDs to which this reminder is attached to (e.g. requestId))
subject
required
string

Responses

Request samples

Content type
application/json
{
  • "activity": "UNDEFINED_REMINDER_ACTIVITY",
  • "contactId": "string",
  • "date": "string",
  • "done": "string",
  • "employeeUserId": "string",
  • "ownerId": "string",
  • "priority": "NORMAL_REMINDER_PRIORITY",
  • "referenceIds": [
    ],
  • "subject": "string"
}

Response samples

Content type
application/json
{
  • "reminder": {
    }
}

ReminderService_CreateBulk

Request Body schema: application/json
required
activity
required
string (reminderReminderActivity)
Default: "UNDEFINED_REMINDER_ACTIVITY"
Enum: "UNDEFINED_REMINDER_ACTIVITY" "CALL_REMINDER_ACTIVITY" "MAIL_REMINDER_ACTIVITY" "POST_REMINDER_ACTIVITY" "TODO_REMINDER_ACTIVITY" "TO_DISCUSS_REMINDER_ACTIVITY" "TO_READ_THROUGH_REMINDER_ACTIVITY"
required
Array of objects (reminderReferenceBucket)

For each bucket one reminder with all referenceIds in that bucket is created

contactId
required
string
date
required
string <int64> (UNIX timestamp in seconds)
done
required
string <int64> (UNIX timestamp in seconds when the reminder was set to done. 0=not done)
employeeUserId
required
string
ownerId
required
string <int64>
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"
subject
required
string

Responses

Request samples

Content type
application/json
{
  • "activity": "UNDEFINED_REMINDER_ACTIVITY",
  • "buckets": [
    ],
  • "contactId": "string",
  • "date": "string",
  • "done": "string",
  • "employeeUserId": "string",
  • "ownerId": "string",
  • "priority": "NORMAL_REMINDER_PRIORITY",
  • "subject": "string"
}

Response samples

Content type
application/json
{ }

ReminderService_List

path Parameters
ownerId
required
string <int64>
query Parameters
employeeIds
Array of strings

Optional, needs to match at least one

priority
Array of strings
Items Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"

Optional, if empty array then no filtering is done

Responses

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

ReminderService_ListByContactIds

Request Body schema: application/json
required
contactIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

ReminderService_ListByReferenceIds2

Request Body schema: application/json
required
includeDone
required
boolean
ownerId
required
string <int64>
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "includeDone": true,
  • "ownerId": "string",
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

ReminderService_ListByReferenceIds

path Parameters
referenceIds
required
Array of strings non-empty
query Parameters
ownerId
string <int64>
includeDone
boolean

Responses

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

ReminderService_SetDone

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

ReminderService_SetUnDone

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Update

Request Body schema: application/json
required
activity
required
string (reminderReminderActivity)
Default: "UNDEFINED_REMINDER_ACTIVITY"
Enum: "UNDEFINED_REMINDER_ACTIVITY" "CALL_REMINDER_ACTIVITY" "MAIL_REMINDER_ACTIVITY" "POST_REMINDER_ACTIVITY" "TODO_REMINDER_ACTIVITY" "TO_DISCUSS_REMINDER_ACTIVITY" "TO_READ_THROUGH_REMINDER_ACTIVITY"
contactId
required
string
date
required
string <int64> (UNIX timestamp in seconds)
done
required
string <int64> (UNIX timestamp in seconds when the reminder was set to done. 0=not done)
employeeUserId
required
string
id
required
string
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"
referenceIds
required
Array of strings (IDs to which this reminder is attached to (e.g. requestId))
subject
required
string

Responses

Request samples

Content type
application/json
{
  • "activity": "UNDEFINED_REMINDER_ACTIVITY",
  • "contactId": "string",
  • "date": "string",
  • "done": "string",
  • "employeeUserId": "string",
  • "id": "string",
  • "priority": "NORMAL_REMINDER_PRIORITY",
  • "referenceIds": [
    ],
  • "subject": "string"
}

Response samples

Content type
application/json
{ }

ReminderService_UpdateDate

Request Body schema: application/json
required
date
required
string <int64> (UNIX timestamp in seconds)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

ReminderService_UpdateEmployee

Request Body schema: application/json
required
employeeUserId
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "employeeUserId": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

ReminderService_UpdatePriority

Request Body schema: application/json
required
ids
required
Array of strings
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "priority": "NORMAL_REMINDER_PRIORITY"
}

Response samples

Content type
application/json
{ }

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "reminder": {
    }
}

Delete

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

NylasService

NylasService_CreateEvent

Request Body schema: application/json
required
required
Array of objects (calendarnylasAttendee)
calendarId
required
string
description
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

frequency
required
string (calendarnylasEventFrequency)
Default: "EVENT_FREQUENCY_UNDEFINED"
Enum: "EVENT_FREQUENCY_UNDEFINED" "EVENT_FREQUENCY_DAILY" "EVENT_FREQUENCY_WEEKLY" "EVENT_FREQUENCY_MONTHLY" "EVENT_FREQUENCY_YEARLY"
location
required
string
mediaIds
required
Array of strings
notifyParticipants
required
boolean

If true, participants will be notified of the event creation

occurrenceCount
required
integer <int32>
ownerId
required
string <int64>
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

referenceIds
required
Array of strings
required
Array of objects (nylasReminders)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

title
required
string
userId
required
string
visibility
required
string (nylasVisibility)
Default: "EVENT_VISIBILITY_UNDEFINED"
Enum: "EVENT_VISIBILITY_UNDEFINED" "EVENT_VISIBILITY_PRIVATE" "EVENT_VISIBILITY_PUBLIC"

Responses

Request samples

Content type
application/json
{
  • "attendees": [
    ],
  • "calendarId": "string",
  • "description": "string",
  • "endDate": {
    },
  • "endTime": {
    },
  • "frequency": "EVENT_FREQUENCY_UNDEFINED",
  • "location": "string",
  • "mediaIds": [
    ],
  • "notifyParticipants": true,
  • "occurrenceCount": 0,
  • "ownerId": "string",
  • "recurrenceEndDate": {
    },
  • "recurrenceStartDate": {
    },
  • "referenceIds": [
    ],
  • "reminders": [
    ],
  • "startDate": {
    },
  • "startTime": {
    },
  • "title": "string",
  • "userId": "string",
  • "visibility": "EVENT_VISIBILITY_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "event": {
    }
}

NylasService_DeleteEvent

path Parameters
id
required
string
query Parameters
userId
string

Responses

Response samples

Content type
application/json
{ }

NylasService_GetEventByIcs

path Parameters
mediaId
required
string

Responses

Response samples

Content type
application/json
{
  • "event": {
    }
}

NylasService_ListAvailableCalendars

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "calendars": [
    ]
}

NylasService_ListCalendarByUserId

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "calendar": {
    }
}

NylasService_ListCalendarsByUserIds

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "calendars": [
    ]
}

NylasService_ListEvents

Request Body schema: application/json
required
attendeeEmails
Array of strings (Optional filter parameter)

Optional filter parameter

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

ownerId
required
string <int64>
referenceIds
Array of strings (Optional filter parameter)

Optional filter parameter

sortStart
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

userIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attendeeEmails": [
    ],
  • "endDate": {
    },
  • "ownerId": "string",
  • "referenceIds": [
    ],
  • "sortStart": "UNDEFINED_SORT_ORDER",
  • "startDate": {
    },
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "events": [
    ]
}

NylasService_ResolveCalendarByEmail

path Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "calendar": {
    }
}

RSVP

Request Body schema: application/json
required
calendarId
required
string
eventId
required
string
iCalUid
required
string
status
required
string (calendarnylasAttendeeStatus)
Default: "ATTENDEE_STATUS_NEEDS_ACTION"
Enum: "ATTENDEE_STATUS_NEEDS_ACTION" "ATTENDEE_STATUS_ACCEPTED" "ATTENDEE_STATUS_DECLINED" "ATTENDEE_STATUS_TENTATIVE"
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "calendarId": "string",
  • "eventId": "string",
  • "iCalUid": "string",
  • "status": "ATTENDEE_STATUS_NEEDS_ACTION",
  • "userId": "string"
}

Response samples

Content type
application/json
{ }

NylasService_SetCalendar

Request Body schema: application/json
required
nylasCalendarId
required
string

Responses

Request samples

Content type
application/json
{
  • "nylasCalendarId": "string"
}

Response samples

Content type
application/json
{
  • "calendar": {
    }
}

NylasService_UpdateEvent

Request Body schema: application/json
required
required
Array of objects (calendarnylasAttendee)
description
required
string
editFollowing
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

frequency
required
string (calendarnylasEventFrequency)
Default: "EVENT_FREQUENCY_UNDEFINED"
Enum: "EVENT_FREQUENCY_UNDEFINED" "EVENT_FREQUENCY_DAILY" "EVENT_FREQUENCY_WEEKLY" "EVENT_FREQUENCY_MONTHLY" "EVENT_FREQUENCY_YEARLY"
id
required
string
location
required
string
mediaIds
required
Array of strings
notifyParticipants
required
boolean

If true, participants will be notified of the event update

occurrenceCount
required
integer <int32>
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

referenceIds
required
Array of strings
required
Array of objects (nylasReminders)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

title
required
string
userId
required
string
visibility
required
string (nylasVisibility)
Default: "EVENT_VISIBILITY_UNDEFINED"
Enum: "EVENT_VISIBILITY_UNDEFINED" "EVENT_VISIBILITY_PRIVATE" "EVENT_VISIBILITY_PUBLIC"

Responses

Request samples

Content type
application/json
{
  • "attendees": [
    ],
  • "description": "string",
  • "editFollowing": true,
  • "endDate": {
    },
  • "endTime": {
    },
  • "frequency": "EVENT_FREQUENCY_UNDEFINED",
  • "id": "string",
  • "location": "string",
  • "mediaIds": [
    ],
  • "notifyParticipants": true,
  • "occurrenceCount": 0,
  • "recurrenceEndDate": {
    },
  • "recurrenceStartDate": {
    },
  • "referenceIds": [
    ],
  • "reminders": [
    ],
  • "startDate": {
    },
  • "startTime": {
    },
  • "title": "string",
  • "userId": "string",
  • "visibility": "EVENT_VISIBILITY_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "event": {
    }
}

CalendarService

CalendarService_CreateEvent

Request Body schema: application/json
required
required
Array of objects (calendarAlarm)
required
Array of objects (calendarcalendarAttendee)
categories
required
Array of strings
countRecurrence
required
integer <int32>
description
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

frequency
required
string (calendarcalendarEventFrequency)
Default: "EVENT_FREQUENCY_UNDEFINED"
Enum: "EVENT_FREQUENCY_UNDEFINED" "EVENT_FREQUENCY_DAILY" "EVENT_FREQUENCY_WEEKLY" "EVENT_FREQUENCY_MONTHLY" "EVENT_FREQUENCY_YEARLY"
location
required
string
mailboxId
required
string
mediaIds
required
Array of strings
ownerId
required
string <int64>
private
required
boolean
referenceIds
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

title
required
string
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ],
  • "attendees": [
    ],
  • "categories": [
    ],
  • "countRecurrence": 0,
  • "description": "string",
  • "endByDateRecurrence": {
    },
  • "endDate": {
    },
  • "endDateOccurrencesResponse": {
    },
  • "endTime": {
    },
  • "frequency": "EVENT_FREQUENCY_UNDEFINED",
  • "location": "string",
  • "mailboxId": "string",
  • "mediaIds": [
    ],
  • "ownerId": "string",
  • "private": true,
  • "referenceIds": [
    ],
  • "startDate": {
    },
  • "startDateOccurrencesResponse": {
    },
  • "startTime": {
    },
  • "title": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "event": {
    },
  • "events": [
    ]
}

CalendarService_DeleteEvent

path Parameters
url
required
string
query Parameters
mailboxId
string
occurrenceEventDate.year
integer <int32>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

occurrenceEventDate.month
integer <int32>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

occurrenceEventDate.day
integer <int32>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

startDateOccurrencesResponse.year
integer <int32>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

startDateOccurrencesResponse.month
integer <int32>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

startDateOccurrencesResponse.day
integer <int32>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

endDateOccurrencesResponse.year
integer <int32>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

endDateOccurrencesResponse.month
integer <int32>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

endDateOccurrencesResponse.day
integer <int32>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

CalendarService_GetCalDavCredentials

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "applePath": "string",
  • "appleUrl": "string",
  • "password": "string",
  • "url": "string",
  • "username": "string"
}

CalendarService_ListEvents

Request Body schema: application/json
required
attendeeEmails
Array of strings (Optional filter parameter)

Optional filter parameter

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

ownerId
required
string <int64>
referenceIds
Array of strings (Optional filter parameter)

Optional filter parameter

sortStart
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

userIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attendeeEmails": [
    ],
  • "endDate": {
    },
  • "ownerId": "string",
  • "referenceIds": [
    ],
  • "sortStart": "UNDEFINED_SORT_ORDER",
  • "startDate": {
    },
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "events": [
    ]
}

CalendarService_ReadEventFromIcal

query Parameters
mediaId
string

Responses

Response samples

Content type
application/json
{
  • "event": {
    }
}

CalendarService_SetExternalAttendeeStatus

Request Body schema: application/json
required
status
required
string (calendarcalendarAttendeeStatus)
Default: "ATTENDEE_STATUS_NEEDS_ACTION"
Enum: "ATTENDEE_STATUS_NEEDS_ACTION" "ATTENDEE_STATUS_ACCEPTED" "ATTENDEE_STATUS_DECLINED" "ATTENDEE_STATUS_TENTATIVE"
token
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "ATTENDEE_STATUS_NEEDS_ACTION",
  • "token": "string"
}

Response samples

Content type
application/json
{ }

CalendarService_UpdateAttendeesStatus

path Parameters
url
required
string
Request Body schema: application/json
required
Array of objects (calendarcalendarAttendee)
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "attendees": [
    ],
  • "occurrenceEventDate": {
    }
}

Response samples

Content type
application/json
{ }

CalendarService_UpdateEvent

Request Body schema: application/json
required
required
Array of objects (calendarAlarm)
required
Array of objects (calendarcalendarAttendee)
categories
required
Array of strings
countRecurrence
required
integer <int32>
description
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

frequency
required
string (calendarcalendarEventFrequency)
Default: "EVENT_FREQUENCY_UNDEFINED"
Enum: "EVENT_FREQUENCY_UNDEFINED" "EVENT_FREQUENCY_DAILY" "EVENT_FREQUENCY_WEEKLY" "EVENT_FREQUENCY_MONTHLY" "EVENT_FREQUENCY_YEARLY"
location
required
string
mailboxId
required
string
mediaIds
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

private
required
boolean
referenceIds
required
Array of strings
resetOccurrencesEvents
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

title
required
string
url
required
string

Responses

Request samples

Content type
application/json
{
  • "alarms": [
    ],
  • "attendees": [
    ],
  • "categories": [
    ],
  • "countRecurrence": 0,
  • "description": "string",
  • "endByDateRecurrence": {
    },
  • "endDate": {
    },
  • "endDateOccurrencesResponse": {
    },
  • "endTime": {
    },
  • "frequency": "EVENT_FREQUENCY_UNDEFINED",
  • "location": "string",
  • "mailboxId": "string",
  • "mediaIds": [
    ],
  • "occurrenceEventDate": {
    },
  • "private": true,
  • "referenceIds": [
    ],
  • "resetOccurrencesEvents": true,
  • "startDate": {
    },
  • "startDateOccurrencesResponse": {
    },
  • "startTime": {
    },
  • "title": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "events": [
    ]
}