Calendars

Update a calendar

patch/v1/calendars/{id}

Request

  • Base URL: https://api.chronary.ai
  • URL: https://api.chronary.ai/v1/calendars/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Calendar ID

Example:cal_01H9X4M2P5R8T6V0

Request body

namestring
timezonestring
agent_status'idle' | 'working' | 'waiting' | 'error'
default_remindersinteger[] nullable
metadataobject

Response

Updated calendar

idstring required
orgIdstring required
agentIdstring nullable required
namestring required
timezonestring required
metadataobject required
externalIdstring nullable required

Provider calendar ID when bridged to an external provider (Phase 3); null otherwise.

providerstring nullable required

External provider this calendar is bridged to (google | microsoft | apple); null otherwise.

deletedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required
agent_status'idle' | 'working' | 'waiting' | 'error' required
default_remindersinteger[] nullable required

Default reminder offsets (minutes before start) inherited by events that don't set their own. null = use the system default (10 min); [] = no reminders.

ical_urlstring uri required

Example response

{
  "id": "cal_01H9X4M2P5R8T6V0",
  "orgId": "org_01H9X4M2P5R8T6V0",
  "agentId": "agt_01H9X4M2P5R8T6V0",
  "name": "Work Calendar",
  "timezone": "America/Los_Angeles",
  "metadata": {},
  "createdAt": "2025-01-15T10:00:00.000Z",
  "updatedAt": "2025-01-15T10:00:00.000Z",
  "agent_status": "idle",
  "default_reminders": [
    10
  ],
  "ical_url": "https://api.chronary.ai/ical/abc123def456ghi789.ics"
}

Changes

No recorded changes to this operation across all 1 revision of this API.