Creates a new Lead Status within the Convoso system.
Endpoint:
GET https://api.convoso.com/v1/status/insert
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
|
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
auth_token |
string |
✅ Yes |
API key for authentication. |
|
status |
string |
✅ Yes |
Unique identifier for the new status (e.g., "Custom"). |
|
name |
string |
✅ Yes |
Human-readable name for the status. Must be 2-6 characters |
|
hex_color |
string |
❌ No |
Hexadecimal color code for UI representation (e.g., "6711d1"). |
|
final |
string |
✅ Yes |
Indicates if the status is final. Accepts "Y" or "N". |
|
reached |
string |
✅ Yes |
Indicates if the lead was reached. Accepts "Y" or "N". |
|
success |
string |
✅ Yes |
Indicates if the status signifies a successful outcome. Accepts "Y" or "N". |
|
dnc |
string |
✅ Yes |
Marks the lead as Do Not Call. Accepts "Y" or "N". |
|
callback |
string |
✅ Yes |
Indicates if a callback is required. Accepts "Y" or "N". |
|
contact |
string |
✅ Yes |
Indicates if contact was made. Accepts "Y" or "N". |
|
voicemail |
string |
✅ Yes |
Indicates if a voicemail was detected Accepts "Y" or "N". |
Example Request
GET https://api.convoso.com/v1/status/insert?auth_token=your_auth_token&name=Custom Status&hex_color=6711d1&final=N&reached=N&success=N&dnc=N&callback=N&contact=N&voicemail=N
Response Format (JSON)
{
"success": true,
"code": 200,
"data": {
"new": "1",
"status": "C001"
}
}
Response Field Definitions
Top-Level Data Object
|
Field |
Type |
Description |
|---|---|---|
|
success |
boolean |
Identifies if the API was executed successfully |
|
code |
integer |
Response Code for API call |
|
data |
object |
Response Object |
Data Object
|
Field |
Type |
Description |
|---|---|---|
|
new |
string (0|1) |
Identifies if the status code value is new |
|
status |
string |
Identifier for the status code. |