Enables the updating of specific Leads.
Endpoint:
POST https://api.convoso.com/v1/leads/update
🔒 Authentication
- Parameter Name: auth_token
- Type: Query Parameter
- Required: Yes
🔎 Query Parameters
Required Lead Information
| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_token | string | ✅ Yes | authorization token |
| lead_id | integer | ✅ Yes | identifier for the lead |
Optional Lead Attributes - Standard Fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| list_id | integer | ❌ Optional | Target List ID |
| phone_code | string | ❌ Optional | Phone code (default is 1) |
| phone_number | phone | ❌ Optional | Primary phone number for the lead |
| status | string | ❌ Optional | Lead status |
| created_by | string | ❌ Optional | Creator user ID |
| last_modified_by | string | ❌ Optional | Modifier user ID |
| owner_id | string | ❌ Optional | Lead owner ID |
| first_name | string | ❌ Optional | First name |
| last_name | string | ❌ Optional | Last name |
| alt_phone_1 | string | ❌ Optional | Cell phone |
| alt_phone_2 | string | ❌ Optional | Work phone |
string | ❌ Optional | Email address | |
| address1 | string | ❌ Optional | Address line 1 |
| address2 | string | ❌ Optional | Address line 2 |
| city | string | ❌ Optional | City |
| state | string | ❌ Optional | State |
| province | string | ❌ Optional | Province |
| postal_code | string | ❌ Optional | ZIP/Postal Code |
| country | string | ❌ Optional | Country |
| gender | string | ❌ Optional | Gender |
| date_of_birth | string | ❌ Optional | Date of Birth |
Optional Lead Attributes - Customer Defined Fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| ... | string | ❌ Optional | All customer defined fields based on customer defined record layout. |
Example Request
POST https://api.convoso.com/v1/leads/update?auth_token=YOUR_AUTH_TOKEN&adaptor_id=&lead_id=1&list_id=&phone_code=1&created_by=&email=&last_modified_by=&owner_id=&first_name=&last_name=&phone_number=8182621448&alt_phone_1=&alt_phone_2=&address1=&address2=&city=&state=&province=&postal_code=&country=&gender=&date_of_birth=
Response Format (JSON)
{
"success": true,
"data": {
"lead_id": 1
}
}
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 |
|---|---|---|
| lead_id | integer | Lead identifier of the updated lead |