Calendario
Cada operación de este grupo: lo que acepta, lo que devuelve y los errores con los que puede responder.
Operaciones
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
fromstringObligatorioStart of the window.
Formatodate-timetostringObligatorioEnd of the window, after
fromand at most 366 days later.Formatodate-timetimezonestringObligatorioIANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
Al menos 1Como máximo 100Predeterminado25cursorstringThe 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.
Devuelve
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.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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.
Cuerpo de la petición
summarystringObligatorioThe title, 1 to 255 characters.
De 1 a 255 caracteresdescriptionstringNotes about the event, up to 8,000 characters.
Hasta 8000 caractereslocationstringWhere it is: a room, an address or a link.
Hasta 255 caracteresurlstringA link that belongs to the event.
Hasta 2000 caracteresFormatouristartstringObligatorioWhen it starts, a
Dateor ISO 8601 with a zone.Formatodate-timeendstringObligatorioWhen 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.Hasta 512 caracteresattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.Hasta 200 elementosemailstringObligatorio- Hasta 320 caracteresFormato
email namestring- Hasta 128 caracteres
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Hasta 5 elementosminutesBeforeintegerObligatorio- Al menos 0Como máximo 40320
actionstring- Uno de
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Uno de"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Uno 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.
Hasta 320 caracteres
Devuelve
The event, with its attendees.
Errores
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
Devuelve
The event.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe event id from
GET /calendar/events.
Cuerpo de la petición
summarystringThe title, 1 to 255 characters.
De 1 a 255 caracteresdescriptionstringNotes about the event, up to 8,000 characters.
Hasta 8000 caractereslocationstringWhere it is: a room, an address or a link.
Hasta 255 caracteresurlstringA link that belongs to the event.
Hasta 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.Hasta 512 caracteresattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.Hasta 200 elementosemailstringObligatorio- Hasta 320 caracteresFormato
email namestring- Hasta 128 caracteres
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Hasta 5 elementosminutesBeforeintegerObligatorio- Al menos 0Como máximo 40320
actionstring- Uno de
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Uno de"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Uno 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.
Hasta 320 caracteres
Devuelve
The event as it stands now.
Errores
- 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.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe event id from
GET /calendar/events.
Devuelve
The event is gone.
Errores
- 403
not_organizer: the event was organised by somebody else.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioEvent id, the
eventIdof an occurrence.
Devuelve
text/calendarAn iCalendar document.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe event id from
GET /calendar/events.
Cuerpo de la petición
fromstringThe address the cancellation comes from. It has to be one the key may send as.
Hasta 320 caracteres
Devuelve
The event, cancelled.
Errores
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe event id from
GET /calendar/events.
Cuerpo de la petición
responsestringObligatorioACCEPTED,DECLINEDorTENTATIVE.Uno de"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
Hasta 320 caracteres
Devuelve
The event, with your answer.
Errores
- 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.
Los errores que puede devolver cualquier operación400401404422500Catálogo de errores
También disponible en
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 ruta
idstringObligatorioThe thread id.
Devuelve
The event.
Errores
Los errores que puede devolver cualquier operación400401403404422500Catálogo de errores
También disponible en
Objetos
CalendarEventobject
objectstringObligatorio- Uno de
"calendar_event" idstringObligatoriouidstringObligatorioThe iCalendar UID every copy of the event shares.
sequenceinteger- Al menos 0
summarystring- Puede ser null
descriptionstring- Puede ser null
locationstring- Puede ser null
urlstring- Puede ser null
startstringObligatorio- Formato
date-time endstringObligatorio- Formato
date-time allDaybooleantimezonestring- Puede ser null
recurrencestringThe RRULE, when it repeats.
Puede ser nullexdatesstring[]statusstringObligatorioCONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- Puede ser null
emailstringnamestring- Puede ser null
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- Puede ser null
threadIdstring- Puede ser null
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]Obligatorioobjectstring- Uno de
"calendar_attendee" emailstringnamestring- Puede ser null
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- Puede ser null
respondedAtstring- Puede ser nullFormato
date-time
createdAtstring- Formato
date-time updatedAtstring- Formato
date-time
DeletedCalendarEventobject
objectstringObligatorio- Uno de
"calendar_event" idstringObligatoriodeletedbooleanObligatorio- Uno de
true