Removes a car from the watchlist for a handle

POST

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

const url = 'https://dashboard.dealerstudio.com.au/api/v1/websites/example/phone_identities/example/remove_from_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/remove_from_watchlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "car_id": 123 }'

Unsaves a car for the contact behind the handle. A POST rather than a DELETE because the website client only supports GET and POST. No contact, or a car belonging to another dealership, is a 400.

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 removed

application/json

object

success

boolean

car_ids

Array<integer>

Example

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

400

Nothing to remove

application/json

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Unable to remove car from watchlist"
}

404

Handle is unknown

application/json

object

error

string

Example

{
  "error": "unknown_handle"
}