Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

A unique integer value identifying this Driver Agreement.

Body

agreement_status
enum<string>
  • ACTIVE - Active
  • INACTIVE - In-active
Available options:
ACTIVE,
INACTIVE
agreement_start_date
string<date-time>
agreement_end_date
string<date-time> | null
agreement_number
string
Maximum string length: 255
plan
string | null
Maximum string length: 255

Response

200 - application/json
id
integer
required
read-only
custom_fields
string
required
read-only
vehicle
object
required
driver
object
required
status
string
required
read-only
agreement_start_date
string<date-time>
required
date_added
string<date-time>
required
read-only
last_updated
string<date-time>
required
read-only
agreement_number
string
required
Maximum string length: 255
agreement_status
enum<string>
  • ACTIVE - Active
  • INACTIVE - In-active
Available options:
ACTIVE,
INACTIVE
agreement_end_date
string<date-time> | null
plan
string | null
Maximum string length: 255