Skip to main content
POST
Close Driver Agreement

Request Format

The request payload should include the agreement_end_date in ISO 8601 format:

Date Format

The agreement_end_date should be provided in ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ Example: 2025-08-30T18:37:34.000Z

Authorizations

Authorization
string
header
required

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

Headers

Fleet-Id
integer
required

ID of the Fleet making the request.

Example:

123

Path Parameters

id
integer
required

Unique identifier of the driver agreement to close.

Example:

66

Body

application/json
agreement_end_date
string<date-time>
required

End date for the agreement in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ).

Example:

"2025-08-30T18:37:34.000Z"

Response

200 - application/json

Driver Agreement Closed Successfully

id
integer

Unique identifier for the driver agreement.

Example:

66

vehicle
object

Vehicle associated with the driver agreement. DEPRECATED: This object will be removed in future API versions.

status
string

Current status of the agreement.

Example:

"open"

agreement_status
string

Current status of the agreement.

Example:

"ACTIVE"

agreement_start_date
string<date-time>

Start date of the agreement.

Example:

"2025-08-16T14:30:00-04:00"

agreement_end_date
string<date-time>

End date of the agreement (updated by this request).

Example:

"2025-08-30T14:37:34-04:00"

date_added
string<date-time>

Date the agreement was added to the system.

Example:

"2025-08-20T11:28:44.086896-04:00"

last_updated
string<date-time>

Date the agreement was last updated.

Example:

"2025-08-20T11:28:44.086911-04:00"

agreement_number
string

Unique agreement number.

Example:

"POWLSSL192192"

plan
string

Plan type for the agreement.

Example:

"unlimited"

driver
integer

ID of the driver linked to this agreement.

Example:

42