> ## Documentation Index > Fetch the complete documentation index at: https://docs.ouraicalling.com/llms.txt > Use this file to discover all available pages before exploring further. # Update personal Loop availability > Replaces the authenticated member's weekly Loop schedule and optionally the Recall appointment calendar. A null timezone inherits the workspace timezone. Omit recall_appointment_calendar_id to keep the saved calendar. Requires a user-owned credential with `loop:write`. ## OpenAPI ````yaml /api-reference/openapi.json patch /loop/availability openapi: 3.1.0 info: title: OurAiCalling API version: 1.0.0 description: >- REST API for OurAiCalling. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. Everything documented here is also exposed as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials and permission model. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: Famulor Loop description: >- Personal business-phone access, directory, presence, devices, and Loop call recents. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Milian Missions description: Recurring jobs that Milian runs unattended on schedule. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage the customers of your white-label workspace on their behalf — list, register, mint access tokens, log in, log out, and transfer credits. Available to reseller workspaces with white-label access, and to platform admins (scoped to direct platform customers). Requires `platform:read` / `platform:write`. - name: API Keys description: >- Self-service API keys for the calling workspace or a same-brand workspace where the credential's user is owner/admin. A key can only mint further keys with a scope subset of its own. - name: Workspaces description: >- List visible workspaces, create an additional workspace for the key owner, and mint a dedicated credential for a selected owner/admin workspace. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /loop/availability: patch: tags: - Famulor Loop summary: Update personal Loop availability description: >- Replaces the authenticated member's weekly Loop schedule and optionally the Recall appointment calendar. A null timezone inherits the workspace timezone. Omit recall_appointment_calendar_id to keep the saved calendar. Requires a user-owned credential with `loop:write`. operationId: updateLoopAvailability requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LoopAvailabilityInput' responses: '200': description: Updated personal availability. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/LoopAvailability' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: schemas: LoopAvailabilityInput: type: object additionalProperties: false required: - schedule_enabled - weekly_availability - timezone properties: schedule_enabled: type: boolean weekly_availability: $ref: '#/components/schemas/LoopWeeklyAvailability' timezone: type: - string - 'null' description: IANA timezone, or null to inherit the workspace timezone. fallback: $ref: '#/components/schemas/LoopAvailabilityFallbackInput' description: Optional. Omit to preserve the saved fallback. recall_appointment_calendar_id: type: - string - 'null' format: uuid description: >- Optional. Bookable workspace calendar used when arranging a Recall appointment. Omit to preserve the saved calendar; null clears it. LoopAvailability: type: object required: - schedule_enabled - weekly_availability - timezone - workspace_timezone - timezone_source - available_now - fallback - recall_appointment_calendar - recall_appointment_calendars properties: schedule_enabled: type: boolean weekly_availability: $ref: '#/components/schemas/LoopWeeklyAvailability' timezone: type: string workspace_timezone: type: string timezone_source: type: string enum: - workspace - personal available_now: type: boolean fallback: $ref: '#/components/schemas/LoopAvailabilityFallback' recall_appointment_calendar: oneOf: - type: 'null' - $ref: '#/components/schemas/LoopRecallCalendar' recall_appointment_calendars: type: array items: $ref: '#/components/schemas/LoopRecallCalendar' LoopWeeklyAvailability: type: object additionalProperties: false required: - mon - tue - wed - thu - fri - sat - sun properties: mon: $ref: '#/components/schemas/LoopAvailabilityDay' tue: $ref: '#/components/schemas/LoopAvailabilityDay' wed: $ref: '#/components/schemas/LoopAvailabilityDay' thu: $ref: '#/components/schemas/LoopAvailabilityDay' fri: $ref: '#/components/schemas/LoopAvailabilityDay' sat: $ref: '#/components/schemas/LoopAvailabilityDay' sun: $ref: '#/components/schemas/LoopAvailabilityDay' LoopAvailabilityFallbackInput: oneOf: - type: object additionalProperties: false required: - type properties: type: const: disabled - type: object additionalProperties: false required: - type - destination_type - destination properties: type: const: cold_transfer destination_type: type: string enum: - phone - sip_uri destination: type: string - type: object additionalProperties: false required: - type - assistant_id properties: type: const: assistant assistant_id: type: string format: uuid - type: object additionalProperties: false required: - type - routing_rule_id properties: type: const: routing_rule routing_rule_id: type: string format: uuid LoopAvailabilityFallback: oneOf: - type: object required: - type properties: type: const: disabled - type: object required: - type - destination_type - destination properties: type: const: cold_transfer destination_type: type: string enum: - phone - sip_uri destination: type: string - type: object required: - type - assistant properties: type: const: assistant assistant: $ref: '#/components/schemas/LoopRecallAssistant' - type: object required: - type - routing_rule properties: type: const: routing_rule routing_rule: type: object required: - id - name properties: id: type: string format: uuid name: type: string LoopRecallCalendar: type: object required: - id - name - status - provider properties: id: type: string format: uuid name: type: string status: type: string provider: type: string enum: - calcom - calendly - acuity - native - etermin - highlevel ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - destination_forbidden - internal_error description: Stable, machine-readable error code. message: type: string description: Human-readable description of the error. LoopAvailabilityDay: type: array maxItems: 4 items: type: array minItems: 2 maxItems: 2 items: type: string pattern: ^(?:[01]\d|2[0-3]):[0-5]\d$ LoopRecallAssistant: type: object required: - id - name - avatar_url properties: id: type: string format: uuid name: type: string avatar_url: type: - string - 'null' format: uri responses: BadRequest: description: Invalid request body or parameters. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid_request message: '"to_number" is required (E.164 format, e.g. +4930123456).' Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. Forbidden: description: >- The API key lacks the required scope, or the plan does not allow this action. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: forbidden message: This API key is missing the required scope "assistants:write". NotFound: description: Resource not found (or it belongs to another workspace). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not_found message: Assistant not found securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access. ````