Skip to main content
PATCH
/
v1
/
companies
/
{company-id}
/
compliance_document_types
/
{id}
Update a Compliance Document Type
curl --request PATCH \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/compliance_document_types/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "external_id": "<string>",
  "description": "<string>",
  "has_expiration": true,
  "dispatch_gating": true,
  "required_vendors": true,
  "required_internal_drivers": true,
  "required_shared_drivers": true,
  "required_equipment": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "has_expiration": true,
    "dispatch_gating": true,
    "required_vendors": true,
    "required_internal_drivers": true,
    "required_shared_drivers": true,
    "required_equipment": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "external_id": "<string>",
    "description": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

​
company-id
string<uuid>
required

Company ID

​
id
string
required

Compliance Document Type ID

Body

application/json
​
name
string

Display name

​
external_id
string

External identifier for integration with external systems

​
description
string

Optional description

​
field_type
enum<string>
Available options:
none,
string,
number,
date,
boolean
​
has_expiration
boolean
​
dispatch_gating
boolean
​
required_vendors
boolean
​
required_internal_drivers
boolean
​
required_shared_drivers
boolean
​
required_equipment
boolean

Response

OK

​
data
ComplianceDocumentType-Read · object
required