Leads - Add New Lead
POST yourdomain.com/api/leads
Header
json
| Field | Type | Description |
|---|---|---|
| Authorization | String |
Basic Access Authentication token. |
Parameter
json
| Field | Type | Description |
|---|---|---|
| source | String |
Mandatory Lead source. |
| status | String |
Mandatory Lead Status. |
| name | String |
Mandatory Lead Name. |
| assigned | String |
Mandatory Lead assigned. |
| client_id (optional) | String |
Optional Lead From Customer. |
| tags (optional) | String |
Optional Lead tags. |
| contact (optional) | String |
Optional Lead contact. |
| title (optional) | String |
Optional Position. |
| email (optional) | String |
Optional Lead Email Address. |
| website (optional) | String |
Optional Lead Website. |
| phonenumber (optional) | String |
Optional Lead Phone. |
| company (optional) | String |
Optional Lead company. |
| address (optional) | String |
Optional Lead address. |
| city (optional) | String |
Optional Lead City. |
| state (optional) | String |
Optional Lead state. |
| country (optional) | String |
Optional Lead Country. |
| default_language (optional) | String |
Optional Lead Default Language. |
| description (optional) | String |
Optional Lead description. |
| custom_contact_date (optional) | String |
Optional Lead From Customer. |
| contacted_today (optional) | String |
Optional Lead Contacted Today. |
| is_public (optional) | String |
Optional Lead google sheet id. |
Success 200
json
| Field | Type | Description |
|---|---|---|
| status | Boolean |
Request status. |
| message | String |
Lead add successful. |
Error 4xx
json
| Name | Type | Description |
|---|---|---|
| status | Boolean |
Request status. |
| message | String |
add fail. |
HTTP/1.1 200 OK
{
"status": true,
"message": "Lead add successful."
}HTTP/1.1 404 Not Found
{
"status": false,
"message": "Lead add fail."
}