Customer Integrations

Update a customer integration

Updates a customer's integration link, such as changing the synced external entity ID.

patch/api/v1/customers/{id}/integrations/{integrationId}

Path parameters

idstring required

Customer slug

integrationIdstring required

Integration details

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

syncedEntityIdstring nullable required

Synced entity id

Response

The updated customer integration object.

Changes

Changed in 10 of the 115 revisions of this API.142

    • added the new ContractNotFound enum value to the code response property for the response status 404

      response-property-enum-value-added

    • added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new STRIPE_INVOICING enum value to the data/vendorIdentifier response property for the response status 200

      response-property-enum-value-added

    • added the new GovernanceNotEnabled enum value to the code response property for the response status 403

      response-property-enum-value-added

    • added the new AIRWALLEX enum value to the data/vendorIdentifier response property for the response status 200

      response-property-enum-value-added

    • added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

    • added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new PREQUEL enum value to the data/vendorIdentifier response property for the response status 200

      response-property-enum-value-added

    • added the new DataExportIntegrationError enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new RECEIVED enum value to the data/vendorIdentifier response property for the response status 200

      response-property-enum-value-added