Saltar para a documentação
API

Subscrições de calendário

Outros calendários que subscreve através de uma ligação, cujos eventos aparecem no seu calendário só de leitura.

POST/calendar/subscriptions

Executa qualquer uma das 5 chamadas no seu espaço de trabalho.

POST /calendar/subscriptions

Outros calendários que subscreve através de uma ligação, cujos eventos aparecem no seu calendário só de leitura.

Subscrever

Requer calendar:write. url é uma ligação https, http ou webcal para um ficheiro iCalendar, e name assume por predefinição o nome que o calendário dá a si próprio.

curl
curl -X POST "$OE/calendar/subscriptions" -H "$AUTH" -H 'content-type: application/json' -d '{ "url": "webcal://example.com/holidays.ics", "color": "green" }'
Resposta
{  "object": "calendar_subscription",  "id": "csb_8d3f0a2b9c4e41f7a6b5c2d1",  "name": "Public holidays",  "url": "https://example.com/holidays.ics",  "color": "green",  "status": "active",  "lastError": null,  "eventCount": 24,  "lastSyncedAt": "2026-10-10T12:00:03.000Z",  "lastFetchedAt": "2026-10-10T12:00:03.000Z",  "createdAt": "2026-10-10T12:00:01.000Z"}

O calendário é lido de imediato e depois aproximadamente a cada 30 minutos. GET /calendar/subscriptions lista as subscrições, PATCH /calendar/subscriptions/{id} muda o nome de uma ou a sua color, POST /calendar/subscriptions/{id}/refresh lê uma de novo agora, e DELETE /calendar/subscriptions/{id} remove-a com os seus eventos.

Uma ligação que não responde com um calendário dá 422 calendar_subscription_unreadable, uma que já subscreve dá 409 calendar_subscription_exists, e uma atualização a menos de um minuto da última leitura dá 429 calendar_subscription_refresh_too_soon. status passa a failing enquanto as leituras falham e a stopped depois de dez falhas seguidas, com o motivo em lastError.

Os eventos de uma subscrição trazem o respetivo subscriptionId e não podem ser alterados: tentar fazê-lo dá 403 event_read_only. Uma chave limitada a alguns endereços ou domínios dá 422 capability_unsupported.

Referência