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

# Replace assistant integrations

> REPLACE the integration assignments of an assistant with the given set. Pass an empty array to remove all assignments (possible even after a plan downgrade); assigning requires the `calendar_integrations` plan feature and an admin-level credential.

**Required scope:** `integrations:write` or `assistants:write` (keys without scope restrictions have full access).



## OpenAPI

````yaml /api-reference/openapi.json put /assistants/{id}/integrations
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: 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: 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. A key can only mint
      further keys with a scope subset of its own.
  - name: SMS
    description: Outbound SMS from workspace phone numbers.
paths:
  /assistants/{id}/integrations:
    put:
      tags:
        - Integrations
      summary: Replace assistant integrations
      description: >-
        REPLACE the integration assignments of an assistant with the given set.
        Pass an empty array to remove all assignments (possible even after a
        plan downgrade); assigning requires the `calendar_integrations` plan
        feature and an admin-level credential.


        **Required scope:** `integrations:write` or `assistants:write` (keys
        without scope restrictions have full access).
      operationId: setAssistantIntegrations
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Assistant ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - integration_ids
              properties:
                integration_ids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: Complete target set of integration IDs.
      responses:
        '200':
          description: The new assignment set.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Integration'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Integration:
      type: object
      description: >-
        A calendar integration. `config` is provider-specific; secret values are
        always masked as `•••`.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: Display name (unique per workspace).
        provider:
          type: string
          enum:
            - calcom
            - calendly
            - acuity
            - google_calendar
            - outlook_calendar
            - native
            - etermin
          description: Immutable after creation.
        config:
          type: object
          description: >-
            Provider-specific configuration. calcom: `{ api_key_encrypted,
            event_type_id, timezone? }`. calendly: `{ connection_id,
            event_type_id, event_type_name?, event_type_duration_min?,
            location?: { kind, label?, location?, requires_input? },
            booking_mode ('api'|'link'), link_channel ('sms'|'email'),
            allowed_ops?: { book, cancel, reschedule } }`; use the Calendly
            discovery endpoints first, and note that `reschedule` is always
            false. Full Calendly resource URIs are never exposed. acuity writes
            accept `{ connection_id, appointment_type_id, calendar_id?,
            allowed_ops?: { book, cancel, reschedule } }`; responses
            additionally contain provider-canonical `appointment_type_name`,
            `appointment_type_duration_min`, `appointment_type_kind`,
            `calendar_name`, and `timezone`. Use the Acuity discovery endpoints
            first, omit `calendar_id` to use any compatible calendar, and note
            that `reschedule` is forced false for `series`. Client-supplied
            Acuity metadata is never authoritative. Acuity account identifiers
            and all OAuth tokens are never exposed. etermin: `{
            public_key_encrypted, secret_key_encrypted, service_id, calendar_id,
            service_name?, calendar_name?, duration_min?, timezone?,
            webhook_token (auto), webhook_secret? }` — inbound Web Push at `POST
            /api/webhooks/etermin/{webhook_token}`. google_calendar /
            outlook_calendar: `{ connection_id, calendar_id?,
            default_duration_min?, summary_template? }`. native: `{
            event_type_id }` (booking event type UUID). Secret values are masked
            as `•••` in responses; send `•••` on update to keep a stored legacy
            secret.
        is_active:
          type: boolean
        status:
          type: string
          enum:
            - ok
            - error
            - link_mode
          description: >-
            `link_mode` = Calendly fallback: the plan cannot use the Scheduling
            API, the assistant sends a single-use scheduling link instead of
            hard-booking.
        last_error:
          type:
            - string
            - 'null'
        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
                - not_found
                - invalid_request
                - rate_limited
                - conflict
                - telephony_configuration_error
                - telephony_unavailable
                - internal_error
              description: Stable, machine-readable error code.
            message:
              type: string
              description: Human-readable description of the error.
  responses:
    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`, `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.

````