3.4 Close Driver
Updated at: 3/3/2022 5:22:58 AM
Url
/api/v2/{fleet_token}/contractors/{contractor_id}/drivers/close/{id}
Method
Post
Body
``` json
{
"EffectiveDate": "<date:Date>"
}
```
Parameters
- `EffectiveDate`. Optional. You could leave the body blank if you like. The default value for effective date is **Today**.
Response
```json
{
"Success": "<true|false>",
"Message": "<message>",
"Data": {
"ID": "<driver_id>",
"Number": "<number>",
"FirstName": "<first_name>",
"MiddleName": "<middle_name>",
"LastName": "<last_name>",
"Dob": "<dob:Date>",
"Email": "<email>",
"PhoneNumber": "<phone_number>",
"CellNumber": "<cell_number>",
"Address": "<address>",
"Address2": "<address2>",
"City": "<city>",
"State": "<state>",
"Zip": "<zip>",
"License": "<license>",
"LicenseState": "<license_state>",
"InactivationDate":""
}
}
```
Returns
- `Success`. True or false.
- `Data`. Optional. The element would be absent if the request fails.
Notes
- The request fails if the motor carrier cannot be located by `fleet_token`.
- The request fails if the contractor can't be located by `contractor_id`.
- The specified driver would be removed from all existing units effective the date provided.
In this article