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}

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const customerIntegrationResponse = await client.v1.customers.integrations.update('integrationId', {
  id: 'id',
  syncedEntityId: 'syncedEntityId',
});

console.log(customerIntegrationResponse.data);

200

{
  "data": {
    "id": "<string>",
    "syncedEntityId": "<string>",
    "syncData": {
      "billingId": "<string>",
      "billingLinkUrl": "<string>",
      "priceGroupPackageBillingId": "<string>"
    }
  }
}

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

Integration details

Maximum string length: 255

Body

application/json

Updates a customer integration link.

syncedEntityId · string | null · required

Synced entity id

Maximum string length: 255

Response

200

application/json

The updated customer integration object.

Response object

data · CustomerIntegration · object · required

External billing or CRM integration link

Show child attributes