Scheduling

Request an appointment

post

Sends a request for an appointment

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

vidstring · alphanumericRequired

The unique external indentifier for the user's session.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

sidstring · alphanumericOptional

The unique external indentifier for the user's current session.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

Header parameters

x-dm-access-keystringRequired

The unique identifier of your dealer. Refer to Console > Dealers to get or setup your dealer access key.

x-api-keystringRequired

Your app's client ID.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

Body

application/json

The payload for requesting an appointment.

vinstring · vinOptional

The unique identification number or Vehicle Identification Number (VIN) that is assigned to all vehicles.

Example: 1GTHK24U85E335250

yearnumberOptional

The year of the vehicle.

Example: 2023

makestringOptional

The make of the vehicle.

Example: Acura

modelstringOptional

The model of the vehicle.

Example: TLX

date_timestringOptional

An ISO date and time for the appointment.

Example: 2023-02-11T13:14:30+00:00

Responses

200

The list of options and services available.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

post

/v1/scheduling

HTTPcURLJavaScriptPython

POST /v1/scheduling?vid=text HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 422

{
  "customer": {
    "first_name": "John",
    "middle_name": "Parker",
    "last_name": "Smith",
    "suffix": "Jr",
    "email": "[email protected]",
    "home_phone": "2221110000",
    "mobile_phone": "2221110000",
    "address_1": "1 Main St",
    "address_2": "401",
    "city": "Boston",
    "state": "MA",
    "zip": "02215",
    "vid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "vin": "1GTHK24U85E335250",
  "year": 2023,
  "make": "Acura",
  "model": "TLX",
  "date_time": "2023-02-11T13:14:30+00:00",
  "options": []
}

{
  "customer": {
    "first_name": "John",
    "middle_name": "Parker",
    "last_name": "Smith",
    "suffix": "Jr",
    "email": "[email protected]",
    "home_phone": "2221110000",
    "mobile_phone": "2221110000",
    "address_1": "1 Main St",
    "address_2": "401",
    "city": "Boston",
    "state": "MA",
    "zip": "02215",
    "vid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "vin": "1GTHK24U85E335250",
  "year": 2023,
  "make": "Acura",
  "model": "TLX",
  "date_time": "2023-02-11T13:14:30+00:00",
  "options": []
}