Please see this article for information on API authorization, testing endpoints, and how obtain your API key.
If you would like to programmatically create and launch new client accounts for your agency or white label account, you can leverage our "agency/clientQuickStart" API endpoint to achieve this.
The endpoint to create and launch new client accounts can be found under "/api/v1.0/agency/clientquickstart" as shown below.
The call to this endpoint must be an HTTP POST with JSON data (Content-Type: application/json). The input parameters and output of this call are self documented in the Swagger documentation as shown:
Input Parameters
Sample Input JSON Payload
{
"clientName": "Sample Client Account Name",
"clientEmail": "[email protected]",
"accountType": "B2C",
"addToBillingPlan": true,
"markCampaignActive": true,
"campaignMonthlyLeadCap": 200,
"campaignLeadCapResetDayOfMonth": 12,
"dataDeliveryPriorityId": 1,
"campaignAutomationDefinition": null,
"ZipFilters": [],
"StateFilters": [],
"EnabledServiceIds": []
}
Success Result
Sample Success Result JSON Payload
{
"password": "h&cqXRt5",
"accountId": 34134,
"audienceId": 28256,
"campaignId": 9398,
"pixelCode": "<img src='https://rdcdn.com/rt?aid=28256&e=1&img=1' height='1' width='1' referrerpolicy='no-referrer-when-downgrade' />",
"javaScriptCode": "<script type='text/javascript'>\r\n (function (w, d, s, u, dbg) {\r\n var js, fjs = d.getElementsByTagName(s)[0];\r\n window.rdcndbg = dbg;\r\n js = d.createElement(s);\r\n js.async = true;\r\n js.src = u;\r\n fjs.parentNode.insertBefore(js, fjs);\r\n })(window, document, 'script', 'https://rdcdn.com/rtjs?aid=28256', false);\r\n</script>"
}
Sample Postman Collection
You can find a sample Postman collection for calling this API in our staging environment below. Note that you will need to obtain your API key from staging by logging into https://staging.leadpost.com and following the Authorization instructions. If you don't have Postman, you can download it for free at https://www.postman.com/downloads/. Once installed, you can import this collection, plug in your API key as shown below, and then run a test call.
