Add or Update Lead Quality

post
Add or Update Lead Quality

[PlatformAddress]/api/1.0/crm?action=addOrUpdateLeadQuality
Request
Response
Request
Path Parameters
id
optional
integer
The unique id of the lead quality (Leave empty if adding a new lead quality)
label
optional
string
The label of the crm lead quality (Required when the ID parameter is missing)
showOnDash
optional
boolean
Whether or not to include leads/opportunities assigned this quality on the venue reporting dashboard
Response
200: OK
{
"success": true,
"id": 755
}

Example Request

Add Lead Quality

{
"label": "A Grade",
"showOnDash": false,
}

Update Lead Quality

{
"id": 755,
"label": "Updated Quality"
}

Returns

Property

Description

success

Whether or not the lead quality was added

id

The unique id of the lead quality

Throws

Code

Description

Specific Code: 24304

The crm lead quality does not exist

Specific Code: 24305

An error has occurred

Specific Code: 24306

The request contains invalid data

Specific Code: 24307

The request contains invalid data

This call takes values for a lead quality, and either

  1. Updates the values for that lead quality (after you have provided an id in the parameters), or

  2. Adds the lead quality to the system (if the id parameter is missing) 1. The result of this call will contain the status of the result (either

    true or false) and the lead quality identifier of the updated or newly

    created lead quality.