Uploads bulk leads to a specified list.
Method: POST
Endpoint:
/omni/leads/bulk/upload
System Authorization: Authorization: Key=your-auth-key
User Authentication: tokenKey: {token}
{ "list_id": <integer>, "dnc_check": <boolean>, "deduplication": <boolean>, "leads": [ { "phone_number_1": <string>, "phone_number_2": <string>, "phone_number_3": <string>, "email_1": <string>, "email_2": <string>, "messenger": <string>, "unique_id": <string>, "title": <string>, "first_name": <string>, "last_name": <string>, "address_line_1": <string>, "address_line_2": <string>, "city": <string>, "province": <string>, "postal_code": <string>, "caller_id": <string>, "schedule_call_date_time": <DateTime> } ] }
Field | Type | Description |
---|---|---|
list_id | integer | The ID of the list. |
dnc_check | boolean | Perform a DNC check on the leads being uploaded. |
deduplication | boolean | Perform a deduplication on the leads being uploaded. |
leads | ||
phone_number_1 | string | Phone number 1 for the lead. |
phone_number_2 | string | Phone number 2 for the lead. |
phone_number_3 | string | Phone number 3 for the lead. |
email_1 | string | Email 1 for the lead. |
email_2 | string | Email 2 for the lead. |
messenger | string | TBA |
reference_id | string | External reference ID for the lead |
title | string | Leads title. |
first_name | string | Leads firstname |
last_name | string | Leads lastname |
address_line_1 | string | Address line 1 |
address_line_2 | string | Address line 2 |
city | string | |
province | string | |
postal_code | string | |
schedule_call_date_time | DateTime | The date and time for the lead to be dialed. Leave null if not needed. |