Update a trailer

curl --request PATCH \
  --url https://clarus-api.com/api/trailers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "trailers",
    "attributes": {
      "code": "TRL-001",
      "name": "Curtainsider 13.6m",
      "trailer_type_id": 7,
      "active": true,
      "description": "Standard 45ft curtainsider"
    }
  }
}
'

{
  "id": 1,
  "code": "TRL-001",
  "name": "Curtainsider 13.6m",
  "active": true,
  "trailer_type_id": 7
}

PATCH

api

trailers

{id}

Update a trailer

curl --request PATCH \
  --url https://clarus-api.com/api/trailers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "trailers",
    "attributes": {
      "code": "TRL-001",
      "name": "Curtainsider 13.6m",
      "trailer_type_id": 7,
      "active": true,
      "description": "Standard 45ft curtainsider"
    }
  }
}
'

{
  "id": 1,
  "code": "TRL-001",
  "name": "Curtainsider 13.6m",
  "active": true,
  "trailer_type_id": 7
}

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

integer

required

The unique identifier of the trailer

Body

application/json

data

object

required

Show child attributes

Response

Updated successfully

The response is of type object.

⌘I