Enables the insertion of Leads into Campaign specific or Global Do Not Call (DNC) Lists.
Endpoint:
POST https://api.convoso.com/v1/callbacks/insert
đź”’ Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | Yes | authorization token |
| lead_id | integer | Yes | ID of the lead to assign the callback to. |
| user_id | integer | No | ID of the user the callback is assigned to. Leave blank to assign to system or default behavior. |
| recipient | string | Yes | Who should receive the callback: "system" (system-generated) or "personal" (specific agent). |
| comments | string | No | Optional notes about the callback. |
| callback_time_zone | string | Yes | Timezone offset in decimal format, e.g., -7.00 for PST/PDT. |
| callback_time | string | Yes | Scheduled time for the callback in format YYYY-MM-DD hh:mm AM/PM. |
Example Request
POST https://api.convoso.com/v1/callbacks/insert?auth_token=YOUR_AUTH_TOKEN&lead_id=9999&user_id=&recipient=system&comments=&callback_time_zone=-7.00&callback_time=
Response Format (JSON)
{
"success": true,
"data": {
"callback_id": "657"
}
}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 |
|---|---|---|
| callback_id | string | Callback identifier for newly created callback. |