Calendar recurrence preview

POST/v1/calendar/recurrence/preview

Signed-in sessionLaunch key product.workOperation calendar_recurrence_preview

A calendar for personal and project events that agents can manage, with full history and rollback.

Body

cursorstring
snapshotobjectRequired
expectedAuthorizationVersionstringRequired
horizonobjectRequired

Returns

contextobjectRequired
freshnessobjectRequired
previewobjectRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

POST/v1/calendar/recurrence/preview

curl "$SPECIFY_API_ORIGIN/v1/calendar/recurrence/preview" \
  -X POST \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>" \
  -H "Content-Type: application/json" \
  -d '{"snapshot":{"state":"active","schemaVersion":1,"time":{"at":1,"kind":"point","timeZone":"<timeZone>"},"exceptions":[{"value":{"kind":"cancel"},"recurrenceId":"<recurrenceId>"}],"title":"<title>","description":"<description>","location":"<location>"},"expectedAuthorizationVersion":"<expectedAuthorizationVersion>","horizon":{"startAt":1,"endAt":1}}'

Response

{
  "result": {
    "context": {
      "accountId": "<accountId>",
      "serviceTenancyId": "<serviceTenancyId>",
      "authorizationVersion": "<authorizationVersion>"
    },
    "freshness": {
      "source": "canonical",
      "asOf": 1,
      "state": "catching_up",
      "watermark": "<watermark>"
    },
    "preview": {
      "status": "budget_exhausted",
      "occurrences": [
        {
          "occurrenceKey": "<occurrenceKey>",
          "recurrenceId": "<recurrenceId>",
          "origin": "override",
          "overridden": true,
          "time": {
            "kind": "all_day",
            "startDate": "<startDate>",
            "endDateExclusive": "<endDateExclusive>"
          },
          "title": "<title>",
          "location": "<location>"
        }
      ],
      "complete": true,
      "cursor": "<cursor>",
      "warnings": [
        "<warning>"
      ],
      "orphaned": [
        {
          "recurrenceId": "<recurrenceId>",
          "value": {
            "kind": "cancel"
          }
        }
      ],
      "counters": {
        "periods": 1,
        "candidates": 1,
        "generated": 1,
        "gaps": 1,
        "excluded": 1,
        "cancelled": 1,
        "overridden": 1,
        "occurrences": 1
      }
    }
  }
}

Calendar recurrence preview

Headers

Body

Returns

Errors