Kalender
Jede Operation in dieser Gruppe: was sie annimmt, was sie zurückgibt und mit welchen Fehlern sie antworten kann.
Operationen
Events and invitations, as the Calendar page of the app shows them: list a window, read an event or the one a thread carries, put events on the calendar and change them, call off a meeting, and answer an invitation. A change that invites, updates or cancels attendees, and every answer, goes out by email, so it also needs emails:send.
GET/calendar/events
List occurrences in a window
from and to are REQUIRED. Occurrences are expanded from recurrence rules, so a calendar has no meaningful unbounded listing. A default window would turn an infinite series into a question with no answer. At most a year apart.
Requires the calendar:read scope.
Query-Parameter
fromstringErforderlichStart of the window.
Formatdate-timetostringErforderlichEnd of the window, after
fromand at most 366 days later.Formatdate-timetimezonestringErforderlichIANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
Mindestens 1Höchstens 100Standard25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
Rückgabe
A page of occurrences, sorted by start and then by event id, with hasMore and nextCursor. Send the same from, to and timezone with every cursor. Nothing in the window is dropped: a series repeats at most once a day, so it gives at most one occurrence per day of the window, and every one is reachable through the pages. The cursor holds the start and event id of the last row, so an event deleted or moved between pages never breaks the walk.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/calendar/events
Create an event
Puts an event on the calendar, as New event on the Calendar page of the app does. start and end are ISO 8601 with a zone, and timezone is the IANA zone the event belongs to, UTC unless you say. recurrence takes an RRULE such as FREQ=WEEKLY;BYDAY=MO, and reminders the minutes before the start.
With attendees, an invitation goes to each of them from the address in from, which has to be one the key or app may send as, so the call also needs emails:send. sendInvites: false keeps the change to your own calendar.
Requires the calendar:write scope.
Request-Body
summarystringErforderlichThe title, 1 to 255 characters.
1 bis 255 ZeichendescriptionstringNotes about the event, up to 8,000 characters.
Bis zu 8000 ZeichenlocationstringWhere it is: a room, an address or a link.
Bis zu 255 ZeichenurlstringA link that belongs to the event.
Bis zu 2000 ZeichenFormaturistartstringErforderlichWhen it starts, a
Dateor ISO 8601 with a zone.Formatdate-timeendstringErforderlichWhen it ends, after
startand at most two years later.Formatdate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.1 bis 64 ZeichenrecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.Bis zu 512 Zeichenattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.Bis zu 200 EinträgeemailstringErforderlich- Bis zu 320 ZeichenFormat
email namestring- Bis zu 128 Zeichen
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Bis zu 5 EinträgeminutesBeforeintegerErforderlich- Mindestens 0Höchstens 40320
actionstring- Einer von
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Einer von"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Einer von"PUBLIC""PRIVATE""CONFIDENTIAL"sendInvitesbooleanFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
Bis zu 320 Zeichen
Rückgabe
The event, with its attendees.
Fehler
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
GET/calendar/events/{id}
Retrieve an event
The event with its attendees and their responses. rawIcs is omitted. Everything understood in it is already structured here, and /ics serves the document.
Requires the calendar:read scope.
Pfadparameter
idstringErforderlichEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
Rückgabe
The event.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
PATCH/calendar/events/{id}
Change an event
Changes an event you organise. A field left out keeps its value, and attendees replaces the whole list. Everyone invited gets the updated invitation.
With attendees, an invitation goes to each of them from the address in from, which has to be one the key or app may send as, so the call also needs emails:send. sendInvites: false keeps the change to your own calendar.
Requires the calendar:write scope.
Pfadparameter
idstringErforderlichThe event id from
GET /calendar/events.
Request-Body
summarystringThe title, 1 to 255 characters.
1 bis 255 ZeichendescriptionstringNotes about the event, up to 8,000 characters.
Bis zu 8000 ZeichenlocationstringWhere it is: a room, an address or a link.
Bis zu 255 ZeichenurlstringA link that belongs to the event.
Bis zu 2000 ZeichenFormaturistartstringWhen it starts, a
Dateor ISO 8601 with a zone.Formatdate-timeendstringWhen it ends, after
startand at most two years later.Formatdate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.1 bis 64 ZeichenrecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.Bis zu 512 Zeichenattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.Bis zu 200 EinträgeemailstringErforderlich- Bis zu 320 ZeichenFormat
email namestring- Bis zu 128 Zeichen
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Bis zu 5 EinträgeminutesBeforeintegerErforderlich- Mindestens 0Höchstens 40320
actionstring- Einer von
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Einer von"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Einer von"PUBLIC""PRIVATE""CONFIDENTIAL"sendInvitesbooleanFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
Bis zu 320 Zeichen
Rückgabe
The event as it stands now.
Fehler
- 403
not_organizer: the event was organised by somebody else, so you can only answer it.from_address_forbidden: the key or app may not send asfrom.- 409
event_cancelled: the meeting was called off.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
DELETE/calendar/events/{id}
Remove an event
Removes an event from the calendar for good, as Remove does in the app. Nobody else is told: to call off a meeting with others in it, use POST /calendar/events/{id}/cancel.
Requires the calendar:write scope.
Pfadparameter
idstringErforderlichThe event id from
GET /calendar/events.
Rückgabe
The event is gone.
Fehler
- 403
not_organizer: the event was organised by somebody else.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
GET/calendar/events/{id}/ics
The event as an .ics document
Served as text/calendar with NO METHOD parameter. A METHOD makes a document actionable (a client seeing method=REQUEST draws accept/decline and can reply to the organiser), and this endpoint has no authority to invite anybody on the workspace behalf. It states what the event currently is.
Requires the calendar:read scope.
Pfadparameter
idstringErforderlichEvent id, the
eventIdof an occurrence.
Rückgabe
text/calendarAn iCalendar document.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
POST/calendar/events/{id}/cancel
Cancel a meeting
Calls off a meeting you organise, as Cancel meeting does in the app. It stays on the calendar with status CANCELLED, and everyone invited is told it is off, from the address in from, so a meeting with attendees also needs emails:send. The body is optional.
Requires the calendar:write scope.
Pfadparameter
idstringErforderlichThe event id from
GET /calendar/events.
Request-Body
fromstringThe address the cancellation comes from. It has to be one the key may send as.
Bis zu 320 Zeichen
Rückgabe
The event, cancelled.
Fehler
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
POST/calendar/events/{id}/respond
Answer an invitation
Accepts, declines or tentatively accepts an invitation, as the buttons of an invitation in the app do. The answer goes to the organiser by email from the invited address the key or app may send as, or from respondingAs when the invitation went to more than one of yours.
Requires the calendar:write and emails:send scopes.
Pfadparameter
idstringErforderlichThe event id from
GET /calendar/events.
Request-Body
responsestringErforderlichACCEPTED,DECLINEDorTENTATIVE.Einer von"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
Bis zu 320 Zeichen
Rückgabe
The event, with your answer.
Fehler
- 403
not_invited: the event did not inviterespondingAs, or any address the key or app may send as.- 409
event_cancelled: the meeting was called off.reply_not_sent: the answer could not be sent to the organiser, so nothing changed.
Die Fehler, die jede Operation zurückgeben kann400401404422500Fehlerkatalog
Auch verfügbar über
GET/threads/{id}/event
The event a thread carries
The calendar event that came with an invitation in the thread, as the invitation card of the reading pane shows it. A thread with no event, or one the key or app does not reach, is a 404. Answer it with POST /calendar/events/{id}/respond.
Requires the calendar:read scope.
Pfadparameter
idstringErforderlichThe thread id.
Rückgabe
The event.
Fehler
Die Fehler, die jede Operation zurückgeben kann400401403404422500Fehlerkatalog
Auch verfügbar über
Objekte
CalendarEventobject
objectstringErforderlich- Einer von
"calendar_event" idstringErforderlichuidstringErforderlichThe iCalendar UID every copy of the event shares.
sequenceinteger- Mindestens 0
summarystring- Kann null sein
descriptionstring- Kann null sein
locationstring- Kann null sein
urlstring- Kann null sein
startstringErforderlich- Format
date-time endstringErforderlich- Format
date-time allDaybooleantimezonestring- Kann null sein
recurrencestringThe RRULE, when it repeats.
Kann null seinexdatesstring[]statusstringErforderlichCONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- Kann null sein
emailstringnamestring- Kann null sein
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- Kann null sein
threadIdstring- Kann null sein
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]Erforderlichobjectstring- Einer von
"calendar_attendee" emailstringnamestring- Kann null sein
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- Kann null sein
respondedAtstring- Kann null seinFormat
date-time
createdAtstring- Format
date-time updatedAtstring- Format
date-time
DeletedCalendarEventobject
objectstringErforderlich- Einer von
"calendar_event" idstringErforderlichdeletedbooleanErforderlich- Einer von
true