Calendário
Cada operação deste grupo: o que aceita, o que devolve e os erros com que pode responder.
Operações
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.
Parâmetros de consulta
fromstringObrigatórioStart of the window.
Formatodate-timetostringObrigatórioEnd of the window, after
fromand at most 366 days later.Formatodate-timetimezonestringObrigatórioIANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
Pelo menos 1No máximo 100Predefinição25cursorstringThe 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.
Devolve
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.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Corpo do pedido
summarystringObrigatórioThe title, 1 to 255 characters.
De 1 a 255 caracteresdescriptionstringNotes about the event, up to 8,000 characters.
Até 8000 caractereslocationstringWhere it is: a room, an address or a link.
Até 255 caracteresurlstringA link that belongs to the event.
Até 2000 caracteresFormatouristartstringObrigatórioWhen it starts, a
Dateor ISO 8601 with a zone.Formatodate-timeendstringObrigatórioWhen it ends, after
startand at most two years later.Formatodate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.De 1 a 64 caracteresrecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.Até 512 caracteresattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.Até 200 itensemailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Até 5 itensminutesBeforeintegerObrigatório- Pelo menos 0No máximo 40320
actionstring- Um de
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Um de"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Um de"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.
Até 320 caracteres
Devolve
The event, with its attendees.
Erros
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
Devolve
The event.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe event id from
GET /calendar/events.
Corpo do pedido
summarystringThe title, 1 to 255 characters.
De 1 a 255 caracteresdescriptionstringNotes about the event, up to 8,000 characters.
Até 8000 caractereslocationstringWhere it is: a room, an address or a link.
Até 255 caracteresurlstringA link that belongs to the event.
Até 2000 caracteresFormatouristartstringWhen it starts, a
Dateor ISO 8601 with a zone.Formatodate-timeendstringWhen it ends, after
startand at most two years later.Formatodate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.De 1 a 64 caracteresrecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.Até 512 caracteresattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.Até 200 itensemailstringObrigatório- Até 320 caracteresFormato
email namestring- Até 128 caracteres
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Até 5 itensminutesBeforeintegerObrigatório- Pelo menos 0No máximo 40320
actionstring- Um de
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Um de"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Um de"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.
Até 320 caracteres
Devolve
The event as it stands now.
Erros
- 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.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe event id from
GET /calendar/events.
Devolve
The event is gone.
Erros
- 403
not_organizer: the event was organised by somebody else.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioEvent id, the
eventIdof an occurrence.
Devolve
text/calendarAn iCalendar document.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe event id from
GET /calendar/events.
Corpo do pedido
fromstringThe address the cancellation comes from. It has to be one the key may send as.
Até 320 caracteres
Devolve
The event, cancelled.
Erros
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe event id from
GET /calendar/events.
Corpo do pedido
responsestringObrigatórioACCEPTED,DECLINEDorTENTATIVE.Um de"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
Até 320 caracteres
Devolve
The event, with your answer.
Erros
- 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.
Os erros que qualquer operação pode devolver400401404422500Catálogo de erros
Também disponível em
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.
Parâmetros de caminho
idstringObrigatórioThe thread id.
Devolve
The event.
Erros
Os erros que qualquer operação pode devolver400401403404422500Catálogo de erros
Também disponível em
Objetos
CalendarEventobject
objectstringObrigatório- Um de
"calendar_event" idstringObrigatóriouidstringObrigatórioThe iCalendar UID every copy of the event shares.
sequenceinteger- Pelo menos 0
summarystring- Pode ser null
descriptionstring- Pode ser null
locationstring- Pode ser null
urlstring- Pode ser null
startstringObrigatório- Formato
date-time endstringObrigatório- Formato
date-time allDaybooleantimezonestring- Pode ser null
recurrencestringThe RRULE, when it repeats.
Pode ser nullexdatesstring[]statusstringObrigatórioCONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- Pode ser null
emailstringnamestring- Pode ser null
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- Pode ser null
threadIdstring- Pode ser null
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]Obrigatórioobjectstring- Um de
"calendar_attendee" emailstringnamestring- Pode ser null
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- Pode ser null
respondedAtstring- Pode ser nullFormato
date-time
createdAtstring- Formato
date-time updatedAtstring- Formato
date-time
DeletedCalendarEventobject
objectstringObrigatório- Um de
"calendar_event" idstringObrigatóriodeletedbooleanObrigatório- Um de
true