|
LeadStatus
LeadStatus is a property of the Lead object. It represents a LeadStatus lookup value.
Supported API Calls: List | Add | Update | Delete
Object Properties
LeadStatus shares all properties with its base LookupValue object. Plus the following unique flags:
|
Property |
Type |
Description |
|
IsClosed |
boolean |
Indicates if the LeadStatus represents a closed condition. |
List
Description
Returns a list of lead status lookup values.
URL
https://{company}.bluecamroo.com/api/leadstatus/list
HTTP Method
GET
Data Return
Returns a list of existing leadstatus objects in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the leadstatus object to the list of lead status lookup values.
URL
https://{company}.bluecamroo.com/api/leadstatus/add
HTTP Method
POST
Parameters
Leadstatus object
Data Return
Returns the leadstatus in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Pass a leadstatus object to replace the specified lead status lookup value.
URL
https://{company}.bluecamroo.com/api/leadstatus/update
HTTP Method
PUT
Parameters
Leadstatus object
Data Return
Returns the leadstatus in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified lead status lookup value. Lead status to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/leadstatus/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|