Customer

Create or Update Customer

post

Create or update a customer.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

vidstring · alphanumericRequired

Unique identifier that is passed by an external system.

Example: 123e4567-e89b-12d3-a456-426614174000

sidstring · alphanumericRequired

Unique session identifier that is passed by an external system.

Example: sese4567-e89b-12d3-a456-426614174000

Responses

200

Returns the created or updated customer details.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

post

/v1/customer

HTTPcURLJavaScriptPython

POST /v1/customer 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: 387

{
  "vid": "123e4567-e89b-12d3-a456-426614174000",
  "sid": "sese4567-e89b-12d3-a456-426614174000",
  "customer_id": "654fds45-e89b-12d3-a456-426614174000",
  "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",
  "customer_id": "654fds45-e89b-12d3-a456-426614174000",
  "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"
}

Get

get

Customer details.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customer_idstring · alphanumericRequired

The unique customer ID.

Example: 654fds45-e89b-12d3-a456-426614174000

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

Responses

200

Returns the customer details.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

get

/v1/customer/{customer_id}

HTTPcURLJavaScriptPython

GET /v1/customer/{customer_id}?vid=text HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Accept: */*

{
  "vid": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "654fds45-e89b-12d3-a456-426614174000",
  "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"
}