This API allows you to add a lead in lead list.
Sample Request
curl --request POST \
--url https://api-smartflo.tatateleservices.com/v1/broadcast/lead/id \
--header 'accept: application/json' \
--header 'content-type: application/json'📘 Important!
Before we begin, note that the * sign denotes the mandatory variables in each table.
Request Variables (Path Params)
The following parameter is required to add a lead in lead list:
| Variable Name | Description | Data Type |
|---|---|---|
| id | Unique ID of the active broadcast. | String |
Request Variables (Body Params)
The following parameter is required to add a lead in lead list:
Variable Name | Description | Data Type |
|---|---|---|
field_0* | Phone number of the lead. | Integer |
filed_1 | Name of the lead. | String |
field_2 | Email of the lead. | String |
field_3 | Address of the lead. | String |
field_4 | Company name of the lead. | String |
field_5 | Custom Field 1. | String |
field_6 | Custom Field 2. | String |
field_7 | Custom Field 3. | String |
field_8 | Custom Field 4. | String |
field_9 | Custom Field 5. | String |
field_10 | Custom Field 6. | String |
field_11 | Custom Field 7. | String |
duplicate_option | It will either allow or prevent the entry of duplicate records. If the number already exists and the following values are passed: "skip": The system will not create a new entry for the lead. "overwrite": The system will update the existing entry with the new details. "clone": The system will create a new entry for the lead. | String |
priority | This variable allows you to set the priority of a lead, with a minimum value of 1 and a maximum value of 30. Note : Priority should be between 1 and 30 where 30 is highest and 1 is lowest. | integer |
skill_id | Unique identifier representing the assigned skill | String |
Response Variables
The response returned is as following:
| Variable Name | Description | Data Type |
|---|---|---|
| Success | The request success status, the possible values are: True (default) for success. False for failure. | Boolean |
| Message | The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here. | String |