Hotnesses
- Hotness visibility
- Retrieving hotnesses
- Submitting a hotness
- Updating hotnesses
- Removing hotnesses
- Deleting a hotness from a contact
- Adding or Updating a contact's hotness
Hotnesses are created in their own endpoint, after which you can then connect a hotness to a contact.
The following fields relate to the Hotnesses endpoint.
| Field | Limits | Required? | Writeable? |
|---|---|---|---|
| id | No | No | |
The id of the hotness | |||
| rank | integer | No | Yes |
The order of the hotness when displayed in lists. Rank of 1 will be at the top of the list" | |||
| user_id | integer | No | No |
The id of the user who created this hotness | |||
| name | 45 characters | No | Yes |
The name of the hotness | |||
| color | 7 characters | No | Yes |
The hex string color | |||
Visibility
The hotnesses that are returned are either:
- Those that you have created
- Those your broker has created, if they have selected to use the setting Use my Hotness Levels with their subaccounts
Retrieving Hotnesses
GET https://api-v2.liondesk.com//hotnesses
headers: {
Authorization: "Bearer [access token]",
Content-Type: "application/json"
}These hotnesses are ordered by the user_id first, then by rank. If you specify a sort in your find, then it will order by that sorting instead.
If you intend to get a specific hotness, submit a get request for /hotnesses/id.
Submitting a hotness
Submit a hotness to have it saved to the database.
POST https://api-v2.liondesk.com//hotnesses
headers: {
Authorization: "Bearer [access token]",
Content-Type: "application/json"
}{
"name": "Pending",
"rank": 14,
"color": "#3b274c"
}Updating hotnesses
You may update a hotness by including the fields you want to change
PATCH https://api-v2.liondesk.com//hotnesses/149
headers: {
Authorization: "Bearer [access token]",
Content-Type: "application/json"
}{
"name": "Cold"
}Removing hotnesses
To delete a hotness, simply submit a delete request and specify the id of the hotness to delete. This will return information corresponding to the hotness you deleted.
DELETE https://api-v2.liondesk.com//hotnesses/149
headers: {
Authorization: "Bearer [access token]",
Content-Type: "application/json"
}{
"id": 149,
"rank": 2,
"user_id": 1,
"name": "Hot",
"color": "#3b274c"
}Deleting a hotness from a contact
To delete a hotness from a contact, you must submit an id of 0 or null.
PATCH https://api-v2.liondesk.com//contacts/1
headers: {
Authorization: "Bearer [access token]",
Content-Type: "application/json"
}{
"hotness_id": 0
}Adding or Updating a contact's hotness
To change which hotness a contact has, submit a different hotness id.
PATCH https://api-v2.liondesk.com//contacts/1
headers: {
Authorization: "Bearer [access token]",
Content-Type: "application/json"
}{
"hotness_id": 148
}This is also how you would add a hotness to a contact too.