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

# Update Intercom settings

> Change the Intercom AI admin, handoff routing, full conversation sync, attachment forwarding, or snooze sync. Omitted fields keep their value.



## OpenAPI

````yaml patch /integrations/intercom/settings
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /integrations/intercom/settings:
    patch:
      summary: Update Intercom settings
      description: >-
        Partially update the Intercom integration settings; omitted fields keep
        their value. Credentials cannot be changed here. Answers 404 when
        Intercom is not connected, 400 for a snooze status that is not a custom
        status of the organization.
      operationId: updateIntercomSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                default_admin_id:
                  anyOf:
                    - type: string
                      minLength: 1
                    - type: 'null'
                handoff_assignment_type:
                  type: string
                  enum:
                    - admin
                    - both_admin_and_team
                    - team
                    - team_least_busy
                    - team_round_robin
                    - unassigned
                  description: >-
                    Where a conversation goes when the AI hands off: unassigned,
                    a team, a team via round robin or least busy, an admin, or
                    both an admin and a team
                handoff_assignment_type_admin_id:
                  description: Admin that receives handoffs; empty string clears it
                  type: string
                handoff_assignment_type_team_id:
                  description: Team that receives handoffs; empty string clears it
                  type: string
                enable_full_conversation_sync:
                  type: boolean
                forward_unsupported_attachments:
                  type: boolean
                snooze_sub_status_id:
                  anyOf:
                    - type: string
                      format: uuid
                      pattern: >-
                        ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                    - type: 'null'
                snooze_duration_hours:
                  type: integer
                  minimum: 1
                  maximum: 720
              additionalProperties: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntercomSettingsEnvelopeDto'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    IntercomSettingsEnvelopeDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/IntercomSettingsEnvelopeDto'
      type: object
      properties:
        connected:
          type: boolean
          description: Whether Intercom is connected for the organization
        settings:
          anyOf:
            - $ref: '#/components/schemas/IntercomPublicSettingsDto'
            - type: 'null'
      required:
        - connected
        - settings
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
    IntercomPublicSettingsDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/IntercomPublicSettingsDto'
      type: object
      properties:
        workspace_id:
          type: string
          description: Intercom workspace ID
        enabled:
          type: boolean
          description: Whether the integration is enabled
        default_admin_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Intercom admin the AI acts as: conversations assigned to it are
            handled by the AI
        handoff_assignment_type:
          type: string
          enum:
            - admin
            - both_admin_and_team
            - team
            - team_least_busy
            - team_round_robin
            - unassigned
          description: >-
            Where a conversation goes when the AI hands off: unassigned, a team,
            a team via round robin or least busy, an admin, or both an admin and
            a team
        handoff_assignment_type_admin_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Admin that receives handoffs (admin / both_admin_and_team)
        handoff_assignment_type_team_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Team that receives handoffs (team* / both_admin_and_team)
        enable_full_conversation_sync:
          type: boolean
          description: >-
            Mirror every Intercom conversation into OpenCX, not only the ones
            the AI handles
        forward_unsupported_attachments:
          type: boolean
          description: >-
            Pass unsupported attachments (PDF, video, audio) on so the AI can
            acknowledge them
        snooze_sub_status_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Custom status mirrored to and from the Intercom snoozed state; null
            = off
        snooze_duration_hours:
          type: number
          description: >-
            Hours a conversation stays snoozed on Intercom when that status is
            applied
      required:
        - workspace_id
        - enabled
        - default_admin_id
        - handoff_assignment_type
        - handoff_assignment_type_admin_id
        - handoff_assignment_type_team_id
        - enable_full_conversation_sync
        - forward_unsupported_attachments
        - snooze_sub_status_id
        - snooze_duration_hours
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.