Vision Developers
POST/calendar/v1/recurrence-commands

Modify or cancel one materialized occurrence in a local series

The approved contract does not provide a longer purpose statement for this operation.

App
Calendar
Contract
Calendar API 1.20.0
Lifecycle
preview
Runtime
restricted
Operation ID
createRecurrenceCommand
Canonical origin
https://calendar.runonvision.com

Availability: This is a preview contract with runtime status restricted. Publication documents an approved interface; it does not imply public production access.

Purpose and use cases

Modify or cancel one materialized occurrence in a local series

The owning App is Vision Calendar. Calendar owns scheduling resources, workspace and actor bindings, visibility, recurrence, conflict, and concurrency rules.

Business use cases and out-of-scope behavior are not yet declared in the approved OpenAPI description.

Request

POST https://calendar.runonvision.com/calendar/v1/recurrence-commands

Authentication and authorization

Send a Vision-issued bearer token for the exact App audience. The token must include the calendar entitlement and satisfy the calendar workspace reference required binding.

  • Required scope: calendar:recurrence:write

Human roles are not declared in OpenAPI. Record-level and business permission checks remain the owning App's authority.

Headers

  • Authorization: Bearer <access-token> — required.
  • Accept: application/json — recommended where a JSON response is declared.
  • Content-Type: application/json — required for the documented request representation.

Undeclared tracing, idempotency, conditional-request, and version headers are not assumed on this page.

Path and query parameters

NameLocationTypeRulesDescription
Idempotency-Keyheaderstringrequired; minimum length 16; maximum length 160; pattern ^[A-Za-z0-9._:-]+$Actor-scoped key. Reusing it with an identical parsed command replays the durable result; reusing it for a different command returns IDEMPOTENCY_CONFLICT.

Request body

Media type: application/json. The body is required.

object | object | object

Runnable examples

Placeholder values are generated from the approved schema and are not live credentials or customer data. Replace every angle-bracket or shell variable value. Examples cannot be run until the App has a routed base URL and your client has the required grant.

CancelOccurrence

Set operation to "cancelOccurrence".

FieldTypeRulesDescription
operation"cancelOccurrence"requiredNot described in the contract.
eventReferencestringrequired; pattern ^EVT-[A-Z0-9]{12}$Not described in the contract.
occurrenceReferencestringrequired; pattern ^EOC-[A-Z0-9]{12}$Not described in the contract.
expectedEventVersionintegerrequired; minimum 1Not described in the contract.
expectedOccurrenceVersionintegerrequired; minimum 1Not described in the contract.
CancelOccurrence — cURL
curl 'https://calendar.runonvision.com/calendar/v1/recurrence-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "cancelOccurrence",
    "eventReference": "<eventReference>",
    "occurrenceReference": "<occurrenceReference>",
    "expectedEventVersion": 1,
    "expectedOccurrenceVersion": 1
  }'
CancelOccurrence — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/recurrence-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "cancelOccurrence",
  "eventReference": "<eventReference>",
  "occurrenceReference": "<occurrenceReference>",
  "expectedEventVersion": 1,
  "expectedOccurrenceVersion": 1
}),
})

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()
CancelOccurrence — Python 3 standard library
import json
import urllib.request

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/recurrence-commands',
    data=json.dumps({"operation":"cancelOccurrence","eventReference":"<eventReference>","occurrenceReference":"<occurrenceReference>","expectedEventVersion":1,"expectedOccurrenceVersion":1}).encode(),
    headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "Accept": "application/json",
    "content-type": "application/json"
},
    method='POST',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

ModifyOccurrence

Set operation to "modifyOccurrence".

FieldTypeRulesDescription
operation"modifyOccurrence"requiredNot described in the contract.
eventReferencestringrequired; pattern ^EVT-[A-Z0-9]{12}$Not described in the contract.
occurrenceReferencestringrequired; pattern ^EOC-[A-Z0-9]{12}$Not described in the contract.
expectedEventVersionintegerrequired; minimum 1Not described in the contract.
expectedOccurrenceVersionintegerrequired; minimum 1Not described in the contract.
patchobjectrequiredNot described in the contract.
patch.titlestringoptional; minimum length 1; maximum length 240Not described in the contract.
patch.descriptionstring | nulloptional; maximum length 4000Not described in the contract.
patch.locationstring | nulloptional; maximum length 500Not described in the contract.
patch.startsAtstring · date-timeoptionalNot described in the contract.
patch.endsAtstring · date-timeoptionalNot described in the contract.
ModifyOccurrence — cURL
curl 'https://calendar.runonvision.com/calendar/v1/recurrence-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "modifyOccurrence",
    "eventReference": "<eventReference>",
    "occurrenceReference": "<occurrenceReference>",
    "expectedEventVersion": 1,
    "expectedOccurrenceVersion": 1,
    "patch": {
      "title": "<title>",
      "description": "<description>",
      "location": "<location>",
      "startsAt": "2026-08-21T18:00:00Z",
      "endsAt": "2026-08-21T18:00:00Z"
    }
  }'
ModifyOccurrence — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/recurrence-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "modifyOccurrence",
  "eventReference": "<eventReference>",
  "occurrenceReference": "<occurrenceReference>",
  "expectedEventVersion": 1,
  "expectedOccurrenceVersion": 1,
  "patch": {
    "title": "<title>",
    "description": "<description>",
    "location": "<location>",
    "startsAt": "2026-08-21T18:00:00Z",
    "endsAt": "2026-08-21T18:00:00Z"
  }
}),
})

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()
ModifyOccurrence — Python 3 standard library
import json
import urllib.request

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/recurrence-commands',
    data=json.dumps({"operation":"modifyOccurrence","eventReference":"<eventReference>","occurrenceReference":"<occurrenceReference>","expectedEventVersion":1,"expectedOccurrenceVersion":1,"patch":{"title":"<title>","description":"<description>","location":"<location>","startsAt":"2026-08-21T18:00:00Z","endsAt":"2026-08-21T18:00:00Z"}}).encode(),
    headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "Accept": "application/json",
    "content-type": "application/json"
},
    method='POST',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

UpdateSeries

Set operation to "updateSeries".

FieldTypeRulesDescription
operation"updateSeries"requiredNot described in the contract.
eventReferencestringrequired; pattern ^EVT-[A-Z0-9]{12}$Not described in the contract.
expectedEventVersionintegerrequired; minimum 1Not described in the contract.
resetExceptionsbooleanoptional; default falseRequired true when changing a series schedule or recurrence rule that already has occurrence exceptions; the prior exceptions are discarded before rematerialization.
patchobjectrequiredNot described in the contract.
patch.titlestringoptional; minimum length 1; maximum length 240Not described in the contract.
patch.descriptionstring | nulloptional; maximum length 4000Not described in the contract.
patch.locationstring | nulloptional; maximum length 500Not described in the contract.
patch.startsAtstring · date-timeoptionalNot described in the contract.
patch.endsAtstring · date-timeoptionalNot described in the contract.
patch.timezonestringoptional; minimum length 1; maximum length 100Not described in the contract.
patch.statusconfirmed | tentativeoptionalNot described in the contract.
patch.visibilityprivate | standard | restricted | availability_onlyoptionalNot described in the contract.
patch.attendeeActorReferencesarrayoptional; maximum items 50Internal actor references must be unique. The combined internal and external attendee count may not exceed 50.
patch.recurrenceobjectoptionalCount-bounded recurrence. The frequency, interval, and count combination must expand no farther than two years; byWeekday is required only for weekly rules. Recurring all-day events are not accepted in v1.
patch.recurrence.frequencydaily | weekly | monthlyrequiredNot described in the contract.
patch.recurrence.intervalintegerrequired; default 1; minimum 1; maximum 52Not described in the contract.
patch.recurrence.byWeekdayarrayrequired; maximum items 7Not described in the contract.
patch.recurrence.countintegerrequired; minimum 2; maximum 366Not described in the contract.
patch.externalAttendeesarrayoptional; maximum items 50External email identities must be unique case-insensitively. The combined internal and external attendee count may not exceed 50.
patch.remindersarrayoptional; maximum items 5Replaces the series' active reminder set. Pairs must be unique by channel and minutesBeforeStart.
UpdateSeries — cURL
curl 'https://calendar.runonvision.com/calendar/v1/recurrence-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "updateSeries",
    "eventReference": "<eventReference>",
    "expectedEventVersion": 1,
    "resetExceptions": false,
    "patch": {
      "title": "<title>",
      "description": "<description>",
      "location": "<location>",
      "startsAt": "2026-08-21T18:00:00Z",
      "endsAt": "2026-08-21T18:00:00Z",
      "timezone": "<timezone>",
      "status": "confirmed",
      "visibility": "private",
      "attendeeActorReferences": [
        "<attendeeActorReferences>"
      ],
      "recurrence": {
        "frequency": "daily",
        "interval": 1,
        "byWeekday": [
          "MO"
        ],
        "count": 2
      },
      "externalAttendees": [
        {
          "email": "<email>",
          "displayName": "<displayName>",
          "role": "required"
        }
      ],
      "reminders": [
        {
          "channel": "in_app",
          "minutesBeforeStart": 0
        }
      ]
    }
  }'
UpdateSeries — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/recurrence-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "updateSeries",
  "eventReference": "<eventReference>",
  "expectedEventVersion": 1,
  "resetExceptions": false,
  "patch": {
    "title": "<title>",
    "description": "<description>",
    "location": "<location>",
    "startsAt": "2026-08-21T18:00:00Z",
    "endsAt": "2026-08-21T18:00:00Z",
    "timezone": "<timezone>",
    "status": "confirmed",
    "visibility": "private",
    "attendeeActorReferences": [
      "<attendeeActorReferences>"
    ],
    "recurrence": {
      "frequency": "daily",
      "interval": 1,
      "byWeekday": [
        "MO"
      ],
      "count": 2
    },
    "externalAttendees": [
      {
        "email": "<email>",
        "displayName": "<displayName>",
        "role": "required"
      }
    ],
    "reminders": [
      {
        "channel": "in_app",
        "minutesBeforeStart": 0
      }
    ]
  }
}),
})

if (!response.ok) throw new Error(`Vision API ${response.status}`)
const result = await response.json()
UpdateSeries — Python 3 standard library
import json
import urllib.request

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/recurrence-commands',
    data=json.dumps({"operation":"updateSeries","eventReference":"<eventReference>","expectedEventVersion":1,"resetExceptions":false,"patch":{"title":"<title>","description":"<description>","location":"<location>","startsAt":"2026-08-21T18:00:00Z","endsAt":"2026-08-21T18:00:00Z","timezone":"<timezone>","status":"confirmed","visibility":"private","attendeeActorReferences":["<attendeeActorReferences>"],"recurrence":{"frequency":"daily","interval":1,"byWeekday":["MO"],"count":2},"externalAttendees":[{"email":"<email>","displayName":"<displayName>","role":"required"}],"reminders":[{"channel":"in_app","minutesBeforeStart":0}]}}).encode(),
    headers={
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "Accept": "application/json",
    "content-type": "application/json"
},
    method='POST',
)
with urllib.request.urlopen(request, timeout=30) as response:
    result = json.load(response)

The current TypeScript reference client covers Platform token exchange and core reads. No native SDK helper is declared for this operation; use the HTTP contract directly and follow the SDK guidance.

Responses

StatusMeaningSchema
200Occurrence exception recordedobject
400Request validation failedobject
401Credential missing or invalidobject
403Credential lacks entitlement, scope, or active bindingobject
404No accessible record was foundobject
409Time conflict, stale record version, invalid state, or idempotency-key conflictobject
503Database or required configuration unavailableobject

Success response schema

FieldTypeRulesDescription
schemaVersion"vision-calendar-command-result.v1"requiredNot described in the contract.
operationevent.create | event.update | event.unlink | event.cancel | hold.create | hold.release | attendance.respond | recurrence.exception.cancel | recurrence.exception.modify | recurrence.series.update | availability.policy.set | availability.policy.reset | availability.exception.create | availability.exception.delete | collection.create | collection.rename | collection.recolor | collection.archive | collection.default.set | collection.preference.set | person.sharing.set | request_call.hold | request_call.confirm | request_call.release | request_call.cancelrequiredNot described in the contract.
outcome"succeeded"requiredNot described in the contract.
publicReferencestringrequiredNot described in the contract.
recordVersionintegerrequired; minimum 1Not described in the contract.
replayedbooleanrequiredNot described in the contract.
200 illustrative response
{
  "schemaVersion": "vision-calendar-command-result.v1",
  "operation": "event.create",
  "outcome": "succeeded",
  "publicReference": "<publicReference>",
  "recordVersion": 1,
  "replayed": true
}

Errors and troubleshooting

Error bodies and codes are shown only where the approved contract declares them. Use status, the declared error schema, and any correlation identifier returned by the App; do not infer that two Apps share one envelope.

  • 400 — Request validation failed
  • 401 — Credential missing or invalid
  • 403 — Credential lacks entitlement, scope, or active binding
  • 404 — No accessible record was found
  • 409 — Time conflict, stale record version, invalid state, or idempotency-key conflict
  • 503 — Database or required configuration unavailable

Collection behavior

Pagination: not declared. Filtering/search: not declared. Sorting: not declared.

Cursor lifetime, cursor binding, stable ordering, maximum traversal, and unknown-filter behavior are not assumed unless stated by a parameter description or schema constraint above.

Operational behavior

  • Rate limit: No operation-specific limit or 429 response is declared.
  • Retry: Retry only when the documented error model or response headers authorize it. Timeout and backoff values are not declared by this operation.
  • Idempotency: No idempotency header or replay window is declared.
  • Concurrency: No ETag, If-Match, or optimistic-version header is declared.

Security and privacy

  • Keep client credentials and bearer tokens on trusted servers.
  • Send only to the exact approved HTTPS origin and audience.
  • Treat response data according to the owning App's classification and retention policy; the OpenAPI contract does not itself grant data access.
  • Do not log credentials, tokens, complete private payloads, or secrets.

Edge cases and known documentation gaps

  • No detailed operation description.
  • The request body has no purpose or conditional-rule description.
  • Business roles, timeout, retry budget, rate value, idempotency window, and concurrency behavior are absent unless explicitly stated above.

Contract history and evidence