If you have a third party vendor, you may want to insert leads via API. This will guide you on how to insert a lead through API.

Note: Our system system accepts HTTP Post in RAW format. We do not support nested parameters or multilevel arrays.

From the Dashboard, click on API and select Leads from the drop-down.

Go to the Insert Lead Tab

Under the Insert Lead Tab, you will see the POST Fields that vendors need when creating their Request Query String.

Note: When creating a Request Query String, make sure that you have values for the required fields.

Scroll down to the bottom to see the Example PHP Usage and the Example JSON Response

To test this feature, go to Test Request tab and fill in the information you wanted to show on the test insert.



There are three required values to make a post. These are Authorization Token, List ID and Phone Number. (Please contact your Account Admin IF you do not know the value for the List ID) Also please see FAQ link here to generate your Authorization Token

If you need these leads to be added immediately to the Hopper, set the value of hopper to 1

Hopper Priority Level. The value range is from 0 to 99. The default value is 99.
To set the Hopper priority of leads inserted to the hopper, set the value in hopper_priority

There are instances that the leads inserted to the hopper via API need to be removed after several minutes.
In order to do this, we need to set a value for "hopper_expire_in". 



Note: In order for Hopper Expire to work you need to set Workflow Automation. You should have Trigger Event set to Hopper Expire and no need for Trigger Event. (Click here on how to set it up)

Select the correct Authorization Token for this API from the dropdown box.

Note: You can also filter duplicate numbers, duplicate numbers on the archived list, and check DNC (Do Not Call Numbers). 

For check duplicate numbers, you will have options 0, 1, 2, 3

If check_dup=0 is used, it will not filter any duplicate numbers.
If check_dup=1 is used, then it will check for duplicate against the entire account.
If check_dup=2 is used, then it will check for duplicates against the List_id.
If check_dup=3 is used, then it will check for duplicates against the Campaign.

(To know more about Archive List or How to Archive a List, click here.)

If you want to see the created Request Query String, put a check in the Show Query check box.

Scroll down to the bottom and click on Run

If everything is configured right, the JSON Response will have a success response including the Lead ID of the created lead.
Note: The "id" parameter will be displayed on the response by default (This is configured for integrating with Zapier and should not have any effect on other 3rd-party platforms)

Searching and viewing the leads inserted in the system via API can be done in the Manage Leads Section.

To do this, filter the results using Created By and System API User