Start the Given Contract
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Contract Details
id
Integer required: The id of the contractfuel
Object required: fuel objectodometer
Object required: odometer objectbypass_signatures
Boolean: A value of true will allow a contract to be started without the collection of a digital signature from the customer, default is false.bypass_credit_card_check
Boolean: A value of true will allow a contract to be started without a credit card present on the customer or reservation. Additionally, any tried authorization will not stop the contract from being started. Default is false.vehicle_id
Number required: Vehicle ID.actual_pickup
Date-time: Actual pickup time for the contract, if different from the reservation time.pickup
Date-time: Scheduled pickup time for the contract, if different from the reservation time.dropoff
Date-time: Scheduled dropoff time for the contract, if different from the reservation time.reason
String: Reason for starting the contract, if different from the reservation reason.api-version
Integer required: Target API version.
Response Codes
204 No Content401 Unauthorized403 Forbidden404 Not Found415 Unsupported Media Type422 Unprocessable Content
Example Request
curl --request PUT \
--url https://api.dealerware.com/admin/contracts/id/start \
--header 'accept: application/json' \
--header 'content-type: application/json'
Base URL
https://api.dealerware.com/admin/contracts/{id}/start
Try It!
Click the Try It! button to start a request and see the response.