Get details for an existing campaign.
Method: POST
Endpoint:
/omni/leadSystem Authorization: Authorization: Key=your-auth-key
User Authentication: tokenKey: {token}
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"first_name" : <string>,
"last_name" : <string>,
"other_info" : <string>,
"unique_id" : <string>,
"lead_provider": <string>,
"list_id" : <integer>,
"cost" : <decimal>,
"phone_numbers": [
{
"phone_number" : <string>,
"phone_type_id" : <integer>,
"time_zone_id" : <integer>,
"high_priority" : <boolean>,
"schedule_call_date_time": <dateTime>
}
]
} |
Field Name | Type | Description |
|---|---|---|
first_name | string | Leads firstname |
last_name | string | leads lastname |
other_info | string | [required]This info will be displayed to the agent. |
unique_id | string | The unique id for this leads |
lead_provider | string | The leads supplier |
list_id | integer | The ID of the list for the lead to go into. |
cost | decimal | [optional]Price of the lead |
phone_numbers[] | object array | |
phone_number | string | The phone number to call |
phone_type_id | integer | The type of the number 1: Work 2: Mobile |
time_zone_id | integer | Set to 0 unless specified |
high_priority | boolean | Setting to true will cause the system to immediately dial the lead instead of using the usual dialling priority order. |
schedule_call_date_time | dateTime | Date and Time to place the call to this number. Set to Now() for default behavior. |