Vision Developers
POST/calendar/v1/person-sharing-commands

Choose what colleagues see of your time

Sets the calling actor's own sharing and nobody else's: the body names no person. busy is a Busy block with no title, details shows titles. A person who has not chosen is busy. Requires an Idempotency-Key header.

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

Choose what colleagues see of your time

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/person-sharing-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:collection: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

This operation declares no path or query parameters.

Request body

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

FieldTypeRulesDescription
operation"sharing.set"requiredNot described in the contract.
detailLevelbusy | detailsrequiredNot described in the contract.

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.

cURL
curl 'https://calendar.runonvision.com/calendar/v1/person-sharing-commands' \
  --request POST \
  --header 'authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{
    "operation": "sharing.set",
    "detailLevel": "busy"
  }'
JavaScript (server-side)
const response = await fetch('https://calendar.runonvision.com/calendar/v1/person-sharing-commands', {
  method: 'POST',
  headers: {
    authorization: `Bearer ${ACCESS_TOKEN}`,
    accept: 'application/json',
    'content-type': 'application/json',
  },
  body: JSON.stringify({
  "operation": "sharing.set",
  "detailLevel": "busy"
}),
}

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

request = urllib.request.Request(
    'https://calendar.runonvision.com/calendar/v1/person-sharing-commands',
    data=json.dumps({"operation":"sharing.set","detailLevel":"busy"}).encode(),
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer <ACCESS_TOKEN>",
    "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
200Savedobject
400Invalid request or not authorizedobject

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 — Invalid request or not authorized

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

  • 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