Skip to main content
PATCH
/
api
/
alternative_codes
/
{id}
Update an alternative code
curl --request PATCH \
  --url https://clarus-api.com/api/alternative_codes/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "alternative_codes",
    "attributes": {
      "name": "Customer SKU (legacy)",
      "description": "Deprecated customer code"
    }
  }
}
'
{
  "data": {
    "id": "88",
    "type": "alternative_codes",
    "attributes": {
      "code": "ALT-12345",
      "name": "Customer SKU (legacy)",
      "description": "Deprecated customer code",
      "alternative_code_type_id": 3,
      "alternative_codeable_type": "Product",
      "alternative_codeable_id": 42
    }
  }
}

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 alternative code to update

Body

application/json
data
object
required

Response

Updated successfully

data
object