CustomerBASE API

Set primary external system ID

Sets or updates the primary external system identifier for an organization

put/customerbase/v1/organizations/{id}/links/{externalSystem}/primary

Request

Base URL
https://api.customeros.ai
Auth
API key in header X-CUSTOMER-OS-API-KEY
TypeScript
https://skmtc.dev/customeros/apis/customeros-api/docs/customerbase/v1/organizations/:id/links/:externalSystem/primary/put.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Organization ID or COS ID

externalSystemstring required

External system name

externalIdstring

The ID of the external system to be set as primary required: true example: stripe-1234

Primary ID set successfully

requestIdstring

statusstring

Status indicates the result of the operation ("success" or "error")

{
  "requestId": "1234567890abcdef",
  "status": "success"
}

Nov 8, 202423f9f8588813 Revision changes
- info
  endpoint added
Sep 10, 20241ee4ed170cfa Revision changes
- breaking
  api path removed without deprecation