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

# Update a Custom Integration

> Only the provided attributes change. Send `access_token` to rotate the secret.

## Usage


## OpenAPI

````yaml put /v1/custom_integrations/{uid}
openapi: 3.0.1
info:
  title: Siit Public API
  version: v0
servers:
  - url: https://api.siit.io
security: []
paths:
  /v1/custom_integrations/{uid}:
    parameters:
      - name: uid
        in: path
        description: The UID of the Custom Integration
        required: true
        schema:
          type: string
    put:
      tags:
        - Custom Integration
      summary: Update a Custom Integration
      description: >-
        Only the provided attributes change. Send `access_token` to rotate the
        secret.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom_integration_write'
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_integration_result_object'
      security:
        - bearer: []
components:
  schemas:
    custom_integration_write:
      type: object
      description: >-
        On update, only the provided attributes change; `custom_headers`
        replaces the whole list.
      properties:
        name:
          type: string
          maxLength: 100
          description: The Custom Integration name, unique within the company
        api_doc_url:
          type: string
          format: uri
          maxLength: 2048
          nullable: true
          description: Link to the documentation of the API this integration calls
        access_token:
          type: string
          writeOnly: true
          description: >-
            The secret Siit sends to your API, as configured by `auth_method`.
            Required on creation, even with `auth_method: none`. Never returned.
        auth_method:
          type: string
          enum:
            - api_key
            - basic_auth
            - bearer_token
            - none
          default: bearer_token
          description: >-
            How the secret authenticates requests: `bearer_token`
            (`Authorization: Bearer <secret>`), `api_key` (`<auth_header_name>:
            <secret>`), `basic_auth` (`Authorization: Basic
            base64(<auth_username>:<secret>)`), or `none`
        auth_header_name:
          type: string
          maxLength: 255
          nullable: true
          description: >-
            Header carrying the secret. Required when `auth_method` is
            `api_key`.
        auth_username:
          type: string
          maxLength: 255
          nullable: true
          description: >-
            Username combined with the secret. Required when `auth_method` is
            `basic_auth`.
        custom_headers:
          type: array
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                description: The HTTP header name
              value:
                type: string
                description: >-
                  The HTTP header value. Supports `{{variable}}` interpolation
                  (e.g. `{{company.name}}`), resolved when the request is sent.
          description: >-
            HTTP headers sent with every request of the integration Custom
            Actions
    custom_integration_result_object:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/custom_integration'
    custom_integration:
      type: object
      properties:
        uid:
          type: string
          readOnly: true
          description: The UID of the Custom Integration
        name:
          type: string
          description: The Custom Integration name, unique within the company
        api_doc_url:
          type: string
          nullable: true
          description: Link to the documentation of the API this integration calls
        auth_method:
          type: string
          enum:
            - api_key
            - basic_auth
            - bearer_token
            - none
          description: >-
            How the secret authenticates requests: `bearer_token`
            (`Authorization: Bearer <secret>`), `api_key` (`<auth_header_name>:
            <secret>`), `basic_auth` (`Authorization: Basic
            base64(<auth_username>:<secret>)`), or `none`
        auth_header_name:
          type: string
          nullable: true
          description: >-
            Header carrying the secret. Required when `auth_method` is
            `api_key`.
        auth_username:
          type: string
          nullable: true
          description: >-
            Username combined with the secret. Required when `auth_method` is
            `basic_auth`.
        custom_headers:
          type: array
          items:
            type: object
            required:
              - name
              - value
            properties:
              name:
                type: string
                description: The HTTP header name
              value:
                type: string
                description: >-
                  The HTTP header value. Supports `{{variable}}` interpolation
                  (e.g. `{{company.name}}`), resolved when the request is sent.
          description: >-
            HTTP headers sent with every request of the integration Custom
            Actions
        logo_url:
          type: string
          nullable: true
          readOnly: true
          description: URL of the integration logo
        status:
          type: string
          enum:
            - active
            - deactivated
            - errored
            - initial
            - pending_configuration
            - synchronizable
            - waiting_for_data
          readOnly: true
        created_at:
          type: string
          format: date-time
          description: datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")
          readOnly: true
        updated_at:
          type: string
          format: date-time
          description: datetime formatted as ISO 8601 (e.g. "2020-12-15T03:34:13.000Z")
          readOnly: true
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````