Update an existing Lead Status within the Convoso system.
Endpoint:
POST https://api.convoso.com/v1/status/update
đź”’ 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 of the existing status to be updated (e.g., "C001"). |
| name | string | No | New human-readable name for the status. If left empty, the name remains unchanged. |
| hex_color | string | No | Hexadecimal color code for UI representation (e.g., "0000"). |
| final | string | No | Indicates if the status is final. Accepts "Y" or "N". |
| reached | string | No | Indicates if the lead was reached. Accepts "Y" or "N". |
| success | string | No | Indicates if the status signifies a successful outcome. Accepts "Y" or "N". |
| dnc | string | No | Marks the lead as Do Not Call. Accepts "Y" or "N". |
| callback | string | No | Indicates if a callback is required. Accepts "Y" or "N". |
| contact | string | No | Indicates if contact was made. Accepts "Y" or "N". |
| voicemail | string | No | Indicates if a voicemail was left. Accepts "Y" or "N". |
Example Request
POST https://api.convoso.com/v1/status/update?auth_token=your_auth_token&status=C001&name=Follow-up&hex_color=00ff00&final=N&reached=Y&success=N&dnc=N&callback=Y&contact=Y&voicemail=N
Response Format (JSON)
{
"success": true,
"data": {
"status": "C001"
}
}Response Field Definitions
Top-Level Data Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| data | object | Response Object |
Data Object
| Field | Type | Description |
|---|---|---|
| status | string | Identifier for the status code that was updated |