Lead Ping. Enables lead vendors to validate if a lead meets the customer criteria for insertion into the customer account.
Endpoint:
GET https://api.convoso.com/v1/lead-validation/search
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | ✅ Yes | Authentication token. |
| criteria_key | string | ✅ Yes | The Unique identifier for the search criteria to be applied to the request/ |
| phone_number | string | ✅ Yes | Phone Number of the lead |
| state | string | ❌ No | State the lead is located in. |
| postal_code | string | ❌ No | Postal Code for the lead. |
Example Request
GET https://api.convoso.com/v1/lead-validation/search?auth_token=YOUR_AUTH_TOKEN&criteria_key=ijzvv31tw4o682bwueejxofgt1p07owf&phone_number=9999999999&state=&postal_code=
Response Format (JSON)
{
"success": true,
"result": "Accepted"
}
Response Field Definitions
Response Data Object
| Field | Type | Description |
|---|---|---|
| success | boolean | Identifies if the API was executed successfully |
| result | string | Identifies if the lead can be Posted to the customer account. Values Accepted , Denied |