The Powerlist API gives you access to Powerlist functionality which includes:

  • Add to Powerlist
  • Remove From Powerlist
  • Remove From All Powerlists.

 

You can access your API Key and Business ID in the Kixie Dashboard under Manage > Account Settings > Edit All > Integrations

You must be on the Professional Billing Tier in order to access the API

You can reach out to your Account Manager or contact Support via the live chat in order for an agent to enable the API for you. 

You can make POST requests to this API endpoint:

https://apig.kixie.com/app/event?apikey=<api-key-here>

*Please make sure that you select JSON as your Content-Type* 

You can also set "Content-Type: JSON" in your Header Values. 

 

Add to Powerlist 

This request will add a contact to a Powerlist one at a time. 

Request Body: 

{  
"businessid": "<business-id-here>",
"powerlistId": "<powerlist-id>",
"apikey": "<api-key-here>",
"target": "13106772436",
"eventname": "updatepowerlist",
"firstName": "John",
"lastName": "Doe",
"title": "Mr",
"companyName": "Target Store",
"email": "johndoe@kixie.com",
"extraData": {
"randomColumn": "string here"
}
}
  • 'businessid' (required) - This can be found in the Kixie Dashboard under Manage > Account Settings
  • 'powerlistId' (required) - This can be found in the Kixie Dashboard 
  • 'apikey' (required) - This is already in the URL but needs to be in the payload as well
  • 'target' (required) - This is the phone number of the contact that you would like to add to the Powerlist
  • 'eventname' (required) - Do not change. The value for this field must be 'updatepowerlist'. 
  • 'extraData' (optional) - You can add the custom fields in this object. The key value pair would be the column name and the value of the row in the column. 

 

Remove from Powerlist

This request will allow you remove contacts from a Powerlist. 

Request Body: 

{
"businessid": "<business-id-here>",
"powerlistId": "<powerlist-id-here>",
"target": ["+15854747501","+15854747502"],
"eventname": "removefrompowerlist",
"action": "removefrompowerlist",
"apikey": "<api-key-here>"
}
  • 'businessid' (required) - This can be found in the Kixie Dashboard under Manage > Account Settings
  • 'powerlistId' (required) - This can be found in the Kixie Dashboard
  • 'target' (required) - This will be an array [] of phone numbers in order to remove multiple phone numbers at once
  • 'eventname' (required) - Do not change. The value for this field must be 'removefrompowerlist'. 
  • 'action' (required) - Do not change. The value for this field must be 'removefrompowerlist'. 
  • 'apikey' (required) - This is already in the URL but needs to be in the payload as well

 

Remove from All Powerlists

This request will allow you to remove contacts from all your Powerlists. 

Request Body: 

{
"businessid": "<business-id-here>",
"target": ["+16123553857","+16123380085"],
"eventname": "removefrompowerlist",
"action": "removefromallpowerlists",
"apikey": "<api-key-here>"
}
  • 'businessid' (required) - This can be found in the Kixie Dashboard under Manage > Account Settings
  • 'target' (required) - This will be an array [] of phone numbers in order to remove multiple phone numbers at once
  • 'eventname' (required) - Do not change. The value for this field must be 'removefrompowerlist'. 
  • 'action' (required) - Do not change. The value for this field must be 'removefromallpowerlists'. 
  • 'apikey' (required) - This is already in the URL but needs to be in the payload as well