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

# Update editable fields on a connector

> Updates the configuration settings for an existing connector integration. All body fields
are optional; supply only the fields to change. Re-supplying credentials rotates the stored
secret in AWS Secrets Manager. Setting `status: disconnected` suspends sync jobs without
deleting the configuration.
Requires `integrations:write` scope.




## OpenAPI

````yaml /openapi.yaml patch /integrations/{connector_type}
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /integrations/{connector_type}:
    parameters:
      - name: connector_type
        in: path
        required: true
        description: >-
          Connector type. Enum: stripe, avatax, shippo, printnode, postmark,
          shopify, mapquest, google, openai, plaid, ups, fedex, usps, amazon,
          ebay, wwex
        schema:
          type: string
          enum:
            - stripe
            - avatax
            - shippo
            - printnode
            - postmark
            - shopify
            - mapquest
            - google
            - openai
            - plaid
            - ups
            - fedex
            - usps
            - amazon
            - ebay
            - wwex
    patch:
      tags:
        - Integrations
      summary: Update editable fields on a connector
      description: >
        Updates the configuration settings for an existing connector
        integration. All body fields

        are optional; supply only the fields to change. Re-supplying credentials
        rotates the stored

        secret in AWS Secrets Manager. Setting `status: disconnected` suspends
        sync jobs without

        deleting the configuration.

        Requires `integrations:write` scope.
      operationId: updateIntegrationV1
      requestBody:
        required: true
        description: >
          Allowed fields: display_name, mode, is_active, config, ship_from_name,

          ship_from_address1, ship_from_city, ship_from_state, ship_from_zip,

          seller_id, bank_account_id.

          All other fields return 400 validation_failed.

          Credentials and accounting-override JSONB fields are NOT patchable
          here.
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                display_name:
                  type: string
                mode:
                  type: string
                  enum:
                    - sandbox
                    - live
                is_active:
                  type: boolean
                config:
                  type: object
                  description: Provider-specific config overrides (merged)
                ship_from_name:
                  type: string
                ship_from_address1:
                  type: string
                ship_from_city:
                  type: string
                ship_from_state:
                  type: string
                ship_from_zip:
                  type: string
                seller_id:
                  type: string
                bank_account_id:
                  type: string
                  format: uuid
      responses:
        '200':
          description: Updated connector row
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ConnectorRow'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ConnectorRow:
      type: object
      description: >
        A configured connector row from entity_connectors.

        SECURITY: credentials, webhook_secret, and credentials_secret_arn RAW
        VALUES

        are NEVER returned. has_credentials_secret_arn (boolean) indicates if

        credentials are stored. credentials_masked returns key names only (no
        values).

        These invariants are enforced by the canonical
        listConnectors/getConnectorByType

        handler projection and cannot be overridden by callers.
      properties:
        id:
          type: string
          format: uuid
        entity_id:
          type: string
          format: uuid
        connector_type:
          type: string
          enum:
            - stripe
            - avatax
            - shippo
            - printnode
            - postmark
            - shopify
            - mapquest
            - google
            - openai
            - plaid
            - ups
            - fedex
            - usps
            - amazon
            - ebay
            - wwex
        display_name:
          type: string
        mode:
          type: string
          enum:
            - sandbox
            - live
        is_active:
          type: boolean
        config:
          type: object
          description: Provider-specific configuration (opaque JSON)
        has_webhook_secret:
          type: boolean
          description: >-
            True if a webhook signing secret is configured (value never
            returned)
        has_credentials_secret_arn:
          type: boolean
          description: >-
            True if credentials are stored in AWS Secrets Manager (ARN never
            returned)
        last_sync_at:
          type: string
          format: date-time
          nullable: true
        sync_status:
          type: string
          nullable: true
        sync_error:
          type: string
          nullable: true
        ship_from_name:
          type: string
          nullable: true
        ship_from_address1:
          type: string
          nullable: true
        ship_from_city:
          type: string
          nullable: true
        ship_from_state:
          type: string
          nullable: true
        ship_from_zip:
          type: string
          nullable: true
        seller_id:
          type: string
          nullable: true
        bank_account_id:
          type: string
          format: uuid
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````