Skip to main content
PATCH
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

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-ID
string

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

Path Parameters

id
string
required

Customer slug

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$
integrationId
string
required

The internal ID of the integration this record is linked to

Maximum string length: 255

Body

application/json

Updates a customer integration link. The only field that can be changed is syncedEntityId — to link a customer to a different integration entirely, delete this link and create a new one.

syncedEntityId
string | null
required

The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link.

Maximum string length: 255

Response

The updated customer integration object.

Response object

data
CustomerIntegration · object
required

Links this customer to their record in a specific configured integration (e.g. their Stripe customer ID under your Stripe integration). A customer has at most one link per integration.