Update Lead Cluster
PUT
/api/v1/dealerships/{dealership_slug}/lead_clusters/{id}
const url = 'https://dashboard.dealerstudio.com.au/api/v1/dealerships/example/lead_clusters/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"lead_cluster":{"user_id":1,"lead_state":"new","secondary_user_id":2,"location_id":1,"tags":["High Quality Lead"]}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://dashboard.dealerstudio.com.au/api/v1/dealerships/example/lead_clusters/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "lead_cluster": { "user_id": 1, "lead_state": "new", "secondary_user_id": 2, "location_id": 1, "tags": [ "High Quality Lead" ] } }'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” dealership_slug
required
string
Dealership slug
id
required
string
Lead Cluster ID
Request Body required
Section titled “Request Body required ” Media type application/json
object
user_id
ID of the assigned user
integer
lead_state
State of the lead cluster eg. “new”, “contacted”, “lost”, “invalid”, “converted”
string
secondary_user_id
ID of the secondary assigned user
integer
approved
Approval status of the lead cluster
boolean
location_id
ID of the associated location
integer
lead_status_option_id
ID of the lead status option
integer
tags
Array of tags associated with the lead cluster
Array<string>
car_ids
Array of car IDs associated with the lead cluster
Array<integer>
car_lead_clusters_attributes
Array<object>
object
id
integer
car_id
required
integer
family_id
required
integer
manufacturer_id
required
integer
year
integer
badge
string
colour
string
_destroy
boolean
Example
{ "lead_cluster": { "user_id": 1, "lead_state": "new", "secondary_user_id": 2, "location_id": 1, "tags": [ "High Quality Lead" ] }}Responses
Section titled “ Responses ”When user_id param is blank, assigned user should not be updated
Access denied