Skip to main content
POST
/
v2
/
driver-agreements
/
{id}
/
exchange
cURL
curl --request POST \
  --url https://api.example.com/v2/driver-agreements/{id}/exchange/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agreement_number": "<string>",
  "agreement_start_date": "2023-11-07T05:31:56Z",
  "driver": 123,
  "vehicle": 123,
  "agreement_end_date": "2023-11-07T05:31:56Z",
  "plan": "<string>"
}
'
{
  "agreement_number": "<string>",
  "agreement_start_date": "2023-11-07T05:31:56Z",
  "driver": 123,
  "vehicle": 123,
  "custom_fields": "<string>",
  "agreement_end_date": "2023-11-07T05:31:56Z",
  "plan": "<string>"
}

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_number
string
required
Maximum string length: 255
agreement_start_date
string<date-time>
required
driver
integer
required
vehicle
integer
required
agreement_end_date
string<date-time> | null
plan
string | null
Maximum string length: 255

Response

200 - application/json
agreement_number
string
required
Maximum string length: 255
agreement_start_date
string<date-time>
required
driver
integer
required
vehicle
integer
required
custom_fields
string
required
agreement_end_date
string<date-time> | null
plan
string | null
Maximum string length: 255