Vision Developers
POST/calendar/v1/availability-commands

Set working hours, or create and delete availability exceptions

Closes the gap that availability_policy rows could previously only be written by direct SQL. policy.set SUPERSEDES rather than mutates: availability_policy carries a unique index on (workspace_id, actor_id) where status = active, so setting new hours marks the current row superseded and inserts a new one, preserving the policy that was active when an earlier booking was made. Omitting actorReference targets the calling actor; supplying one targets another actor in the same workspace and returns 404 — indistinguishable from a nonexistent reference — for anything outside it. Requires an Idempotency-Key header.

App
Calendar
Contract
Calendar API 1.20.0
Lifecycle
preview
Runtime
restricted
Operation ID
createAvailabilityCommand
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

Set working hours, or create and delete availability exceptions

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

Request

POST https://calendar.runonvision.com/calendar/v1/availability-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:availability: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-KeyheaderstringrequiredNot described in the contract.

Request body

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

object | 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.

Policy Set

Set operation to "policy.set".

FieldTypeRulesDescription
operation"policy.set"requiredNot described in the contract.
actorReferencenull | ActorReferenceoptionalOmit or null for the calling actor.
timezonestringrequiredNot described in the contract.
weekobjectrequiredNot described in the contract.
week.mondayarrayoptional; maximum items 6Not described in the contract.
week.tuesdayarrayoptional; maximum items 6Not described in the contract.
week.wednesdayarrayoptional; maximum items 6Not described in the contract.
week.thursdayarrayoptional; maximum items 6Not described in the contract.
week.fridayarrayoptional; maximum items 6Not described in the contract.
week.saturdayarrayoptional; maximum items 6Not described in the contract.
week.sundayarrayoptional; maximum items 6Not described in the contract.
Policy Set — cURL
curl 'https://calendar.runonvision.com/calendar/v1/availability-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "policy.set",
    "actorReference": "<actorReference>",
    "timezone": "<timezone>",
    "week": {
      "monday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ],
      "tuesday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ],
      "wednesday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ],
      "thursday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ],
      "friday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ],
      "saturday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ],
      "sunday": [
        {
          "start": "<start>",
          "end": "<end>"
        }
      ]
    }
  }'
Policy Set — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/availability-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "policy.set",
  "actorReference": "<actorReference>",
  "timezone": "<timezone>",
  "week": {
    "monday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ],
    "tuesday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ],
    "wednesday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ],
    "thursday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ],
    "friday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ],
    "saturday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ],
    "sunday": [
      {
        "start": "<start>",
        "end": "<end>"
      }
    ]
  }
}),
})

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

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/availability-commands',
    data=json.dumps({"operation":"policy.set","actorReference":"<actorReference>","timezone":"<timezone>","week":{"monday":[{"start":"<start>","end":"<end>"}],"tuesday":[{"start":"<start>","end":"<end>"}],"wednesday":[{"start":"<start>","end":"<end>"}],"thursday":[{"start":"<start>","end":"<end>"}],"friday":[{"start":"<start>","end":"<end>"}],"saturday":[{"start":"<start>","end":"<end>"}],"sunday":[{"start":"<start>","end":"<end>"}]}}).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)

Policy Reset

Set operation to "policy.reset".

FieldTypeRulesDescription
operation"policy.reset"requiredNot described in the contract.
actorReferencenull | ActorReferenceoptionalOmit or null for the calling actor.
Policy Reset — cURL
curl 'https://calendar.runonvision.com/calendar/v1/availability-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "policy.reset",
    "actorReference": "<actorReference>"
  }'
Policy Reset — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/availability-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "policy.reset",
  "actorReference": "<actorReference>"
}),
})

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

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/availability-commands',
    data=json.dumps({"operation":"policy.reset","actorReference":"<actorReference>"}).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)

Exception Create

Set operation to "exception.create".

FieldTypeRulesDescription
operation"exception.create"requiredNot described in the contract.
actorReferencenull | ActorReferenceoptionalNot described in the contract.
startsAtstring · date-timerequiredNot described in the contract.
endsAtstring · date-timerequiredNot described in the contract.
availabilityavailable | unavailablerequiredNot described in the contract.
operationalLabelnull | stringoptionalOperational facts only. Calendar owns the availability block, not the HR or medical record.
Exception Create — cURL
curl 'https://calendar.runonvision.com/calendar/v1/availability-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "exception.create",
    "actorReference": "<actorReference>",
    "startsAt": "2026-08-21T18:00:00Z",
    "endsAt": "2026-08-21T18:00:00Z",
    "availability": "available",
    "operationalLabel": "<operationalLabel>"
  }'
Exception Create — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/availability-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "exception.create",
  "actorReference": "<actorReference>",
  "startsAt": "2026-08-21T18:00:00Z",
  "endsAt": "2026-08-21T18:00:00Z",
  "availability": "available",
  "operationalLabel": "<operationalLabel>"
}),
})

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

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/availability-commands',
    data=json.dumps({"operation":"exception.create","actorReference":"<actorReference>","startsAt":"2026-08-21T18:00:00Z","endsAt":"2026-08-21T18:00:00Z","availability":"available","operationalLabel":"<operationalLabel>"}).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)

Exception Delete

Set operation to "exception.delete".

FieldTypeRulesDescription
operation"exception.delete"requiredNot described in the contract.
exceptionReferencestringrequired; pattern ^AVX-[A-Z0-9]{12}$Not described in the contract.
expectedVersionintegerrequired; minimum 1Not described in the contract.
Exception Delete — cURL
curl 'https://calendar.runonvision.com/calendar/v1/availability-commands' \
  --request POST \
  --header 'authorization: Bearer ***' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "exception.delete",
    "exceptionReference": "<exceptionReference>",
    "expectedVersion": 1
  }'
Exception Delete — JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/availability-commands', {
  method: 'POST',
  headers: {
  "authorization": "Bearer <ACCESS_TOKEN>",
  "accept": "application/json",
  "content-type": "application/json"
},
  body: JSON.stringify({
  "operation": "exception.delete",
  "exceptionReference": "<exceptionReference>",
  "expectedVersion": 1
}),
})

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

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/availability-commands',
    data=json.dumps({"operation":"exception.delete","exceptionReference":"<exceptionReference>","expectedVersion":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)

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
200Command applied (exception.delete)object
201Record createdobject
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

  • One or more parameters have no field-level 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