Skip to main content

Test Drive Object v2

Accelerate Test Drive Object v2 API, allowing you to manage test drives for opportunities within relationships programmatically.

Tom White avatar
Written by Tom White
Updated over 6 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

relationship ID REQUIRED
integer - ID of your chosen relationship

opportunity ID REQUIRED
integer - ID of your chosen opportunity

Test Drive Requests

GET POST - Retrieve test drives from a relationship or add a new test drive into a relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/opportunities/{id}/test-drives/

Example Payload

POST

{
    "test_drive_status": "New Test Drive",
    "site_location": "Bedford",
    "start_time": "2022-08-19 15:49:00",
    "driver_1_forename": "James",
    "driver_1_surname": "Michaels",
    "driver_1_email_address": "[email protected]"
}

Response

400
​

Returned if the request sent is invalid.

404
​

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "items": [
        {
            "test_drive_id": 4001,
            "test_drive_status": "New Test Drive",
            "description": null,
            "site_location": "Bedford",
            "start_time": "2022-08-19 15:49:00",
            "driver_1_forename": "James",
            "driver_1_surname": "Michaels",
            "driver_1_email_address": "[email protected]",
            "driver_1_licence_number": null,
            "driver_1_licence_check_date": "2022-08-11T23:00:00Z",
            "driver_2_forename": null,
            "driver_2_surname": null,
            "driver_2_email_address": null,
            "driver_2_licence_number": null,
            "driver_2_licence_check_date": null,
            "adaptations_flag": "N",
            "comments": null,
            "last_updated_by": null,
            "last_update_date": "2022-08-18 15:49:51"
        }
    ]
}

Test Drive Attributes

When adding a new test drive via the API, there are a number of fields needed.

Mandatory Fields

Expand to view the mandatory fields

test_drive_status - string

Must be one of the test drive statuses configured in Settings.

start_time - datetime

Maximum 128 characters.

driver_1_forename - string

Maximum 50 characters.

driver_1_surname - string

Maximum 50 characters.

driver_1_email_address - string

Non-Mandatory Fields

Expand to view all non- mandatory fields that can be used

test_drive_id - number

Must not be supplied when using POST or PUT .

description - string

Maximum 128 characters.

site_location - string

Maximum 50 characters.

driver_1_licence_number - string
Maximum 21 characters.

driver_1_licence_check_date - date

driver_2_forename - string
Maximum 50 characters.

driver_2_surname - string
Maximum 50 characters.

driver_2_licence_number - string
Maximum 21 characters.

driver_2_licence_check_date - date

adaptions_y_n - string
Y or N.

comments - string
Maximum 4000 characters.

Related Articles
Opportunity Object v2
Cookie Object v2
Relationship Note Object v2
Cashflow Object v2
Telephone Call Object v2
Did this answer your question?