Adds a car to the watchlist for a handle

POST

/api/v1/websites/{website_id}/phone_identities/{handle}/add_to_watchlist

const url = 'https://dashboard.dealerstudio.com.au/api/v1/websites/example/phone_identities/example/add_to_watchlist';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"car_id":123}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dashboard.dealerstudio.com.au/api/v1/websites/example/phone_identities/example/add_to_watchlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "car_id": 123 }'

Saves a car against the contact behind the handle. The contact is created on a first save, so a customer who has never opened MyGarage can still save a car. Requires the watchlist:phone_identity permission, the same one the read uses.

Authorizations

Bearer

Parameters

Path Parameters

website_id

required

string

Website ID

handle

required

string

Pseudonymous handle

Request Body

application/json

object

car_id

required

integer

Example

Responses

200

Car added

application/json

object

success

boolean

car_ids

Array<integer>

Example

{
  "success": true,
  "car_ids": [
    123,
    456
  ]
}

401

Missing or insufficient API key

404

Handle is unknown

application/json

object

error

string

Example

{
  "error": "unknown_handle"
}