Skip to main content
PATCH
/
api
/
external_entities
/
{id}
Update an external entity
curl --request PATCH \
  --url https://clarus-api.com/api/external_entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "external_entities",
    "attributes": {
      "description": "Red Widget (large)"
    }
  }
}
'
{
  "id": 501,
  "entity_type": "product",
  "code": "SHOP-SKU-1",
  "description": "Red Widget (large)",
  "external_system_reference1": "gid://shopify/Product/123",
  "external_system_reference2": null,
  "external_system_reference3": null,
  "integration_id": 12
}

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

id
integer
required

The unique identifier of the external entity to update

Body

application/json
data
object
required

Response

Updated successfully

Updated record