PUT
/
customerbase
/
v1
/
organizations
/
{id}
/
links
/
{externalSystem}
/
primary
curl --request PUT \
  --url https://api.customeros.ai/customerbase/v1/organizations/{id}/links/{externalSystem}/primary \
  --header 'Content-Type: application/json' \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>' \
  --data '{
  "externalId": "<string>"
}'
{
  "organization": {
    "externalId": "<string>",
    "externalSystem": "<string>",
    "organizationId": "<string>",
    "primary": true
  },
  "requestId": "1234567890abcdef",
  "status": "success"
}

Authorizations

​
X-CUSTOMER-OS-API-KEY
string
header
required

Path Parameters

​
id
string
required

Organization ID or COS ID

​
externalSystem
string
required

External system name

Body

application/json
External system ID details

Request to set or replace the primary external system ID

​
externalId
string

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

Response

200
application/json
Primary ID set successfully

Response structure for external system operations

​
organization
object

The external system information

​
requestId
string
Example:

"1234567890abcdef"

​
status
string

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

Example:

"success"

Get organization details