> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a cloud drive source

> Update a cloud drive sync source (custom display name, app connection, folder, subfolder recursion, file limit, or auto-sync settings). **Required scope:** `knowledge:write` (keys without scope restrictions have full access).



## OpenAPI

````yaml /api-reference/openapi.json patch /knowledge-bases/{id}/drive-sources/{sourceId}
openapi: 3.1.0
info:
  title: Famulor API
  version: 1.0.0
  description: >-
    REST API for Famulor. 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.


    REST operations require API Access through the workspace plan or a recurring
    add-on. Without it, regular operations return `403 api_access_required`. The
    invoice-payment and billing-portal operations remain available with a valid
    credential after a failed plan payment so an owner can recover billing.


    The same customer-facing capabilities are available as MCP tools at
    `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using
    the same credentials, scopes, and workspace access. MCP availability is
    controlled separately by Connect AI / MCP, not by API Access.
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:
  /knowledge-bases/{id}/drive-sources/{sourceId}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Knowledge base ID.
      - name: sourceId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Drive source ID.
    patch:
      tags:
        - Knowledge Bases
      summary: Update a cloud drive source
      description: >-
        Update a cloud drive sync source (custom display name, app connection,
        folder, subfolder recursion, file limit, or auto-sync settings).
        **Required scope:** `knowledge:write` (keys without scope restrictions
        have full access).
      operationId: updateDriveSource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DriveSourceUpdate'
      responses:
        '200':
          description: The updated cloud drive source.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - source
                    properties:
                      source:
                        $ref: '#/components/schemas/DriveSource'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    DriveSourceUpdate:
      type: object
      description: Any subset of the create fields. Only provided fields are changed.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 128
          description: Custom display name shown for this source.
          example: Customer success files
        provider:
          type: string
          enum:
            - googledrive
            - one_drive
            - box
            - dropbox
            - sharepoint_graph
        connection_id:
          type: string
          format: uuid
        folder_id:
          type: string
        folder_name:
          type:
            - string
            - 'null'
          description: >-
            Remote folder name captured from the connected drive. This is
            provider metadata, not the editable source `name`.
        drive_id:
          type:
            - string
            - 'null'
        include_subfolders:
          type: boolean
        max_files:
          type: integer
          minimum: 1
          maximum: 500
        auto_sync:
          type: boolean
        sync_interval_hours:
          type: integer
          minimum: 1
    DriveSource:
      type: object
      description: >-
        A cloud drive sync source of a knowledge base. Syncs files from a Google
        Drive, OneDrive, Box, Dropbox, or SharePoint folder (via an app
        connection) into knowledge documents and charges credits per new/changed
        file (2x the website-crawl per-page price).
      properties:
        id:
          type: string
          format: uuid
        knowledge_base_id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 128
          description: User-defined display name shown for this source.
          example: Support knowledge
        provider:
          type: string
          enum:
            - googledrive
            - one_drive
            - box
            - dropbox
            - sharepoint_graph
          description: Cloud drive provider.
        connection_id:
          type: string
          format: uuid
          description: >-
            App connection used to access the folder (Automations →
            Connections).
        folder_id:
          type: string
          description: Remote folder ID being synced.
        folder_name:
          type:
            - string
            - 'null'
          description: >-
            Remote folder name captured from the connected drive for reference.
            This is provider metadata, not the editable source `name`.
        drive_id:
          type:
            - string
            - 'null'
          description: >-
            Document library drive ID. REQUIRED for provider "sharepoint_graph";
            optional for "one_drive" (SharePoint/Business drives accessed via
            the OneDrive toolkit); unused otherwise.
        include_subfolders:
          type: boolean
          description: Whether subfolders are recursed into.
        max_files:
          type: integer
          description: Maximum files synced per run (1-500).
          example: 50
        auto_sync:
          type: boolean
          description: Re-sync automatically on a schedule.
        sync_interval_hours:
          type: integer
          description: Hours between auto-sync runs (>= 1).
          example: 24
        status:
          type: string
          enum:
            - idle
            - syncing
            - error
          description: Current sync status.
        last_error:
          type:
            - string
            - 'null'
          description: Error from the last run, e.g. "insufficient credits".
        last_synced_at:
          type:
            - string
            - 'null'
          format: date-time
        files_synced:
          type: integer
          description: Files synced in the last run (new/changed files).
        credits_spent:
          type: number
          description: Credits charged in total across all runs of this source.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    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
                - api_access_required
                - 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.
  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 credential lacks the required scope or role, or the workspace does
        not have the required capability.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            scopeDenied:
              summary: Required scope is missing
              value:
                error:
                  code: forbidden
                  message: >-
                    This API key is missing the required scope
                    "assistants:write".
            apiAccessRequired:
              summary: API Access is not available
              value:
                error:
                  code: api_access_required
                  message: >-
                    API Access is not available for this workspace. Review
                    Settings → Plan.
    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_...`). REST operations also require API Access
        for the credential's workspace. 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
        within the workspace's available capabilities.

````