PowerList API

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

• Add to PowerList
• Remove from PowerList
• Remove from All PowerLists

API Info

Requirements: In order to use Kixie API, you must have a paid Kixie account with at least one Professional tier agent. Your default daily usage limit is 10,000 API calls per day. (Each day resets at UTC 00:00.)

Where to find your API Key: In your Kixie Dashboard, go to Manage > Account Settings. View the section called "Integrations." (If you cannot access the Account Settings page, you may not have the appropriate user permissions on your Kixie login.)

First-time use: If you have never used your Kixie API before, you may need to contact Support via live chat in order for us to enable your API key.

Endpoint and Header Info

If you are writing your POST request, you will use this API endpoint. Note that it must include your API key and your Business ID, which are both found in your Kixie Dashboard.

https://apig.kixie.com/app/event?apikey=xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&businessid=xxxxx

Set your Content-Type to JSON, and/or use the example header below.

--header 'Content-Type: application/json'

• For more details & resources, see: Kixie API Documentation

Add to PowerList

This request will add or update a single contact in a specific PowerList.

Note that a PowerList contact is defined by the target phone number. Therefore, even if the same lead (John Doe) has two phone numbers (one for mobile phone, one for office phone), those would be treated as two separate contacts according to Kixie's PowerList API.

Request Body:

{
  "businessid": "xxxxx",
  "powerlistId": "1969",
  "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "target": "18554842053",
  "eventname": "updatepowerlist",
  "firstName": "John",
  "lastName": "Doe",
  "title": "CEO",
  "companyName": "Target Store",
  "email": "johndoe@kixie.com",
  "nextCallRefresher": "Insert notes here",
  "crmUserId": "12345",
  "crmContactId": "56789",
  "duplicateHandling": "overwrite",
  "extraData": {
    "customFieldName": "Insert string here"
  }
}

• "businessid" - Find this in your Kixie Dashboard, under Manage > Account Settings.
• "powerlistId" - Find this in your Kixie Dashboard, under Manage > PowerLists. Note that the I is capitalized.
• "apikey" - Your API key is already in the endpoint URL, but must be in the API body as well.
• "target" - The phone number you are adding or updating. Most phone number formats will work fine, but for best results, use E.164 phone number format. (Example: 18005551234)
• "eventname"- Do not change. The value must be "updatepowerlist".
• "email" (optional) - If you do include an email for your contact, it must follow valid formatting rules. For example, if you input an invalid email address (such as johndoe@k) then the API action will fail.
• "nextCallRefresher" (optional) - This field is for visible PowerList Notes. You may include a string, which will appear as contact notes in the PowerDialer text box labeled PowerList Notes.
• "crmUserId" and "crmContactId" (optional) - You may insert IDs from your CRM integration. These fields are helpful if you are building this API request by using automation tools inside your CRM.
• "duplicateHandling" - Determines how to handle this data if the same phone number (in other words, a duplicate contact) is already present in this PowerList. Use one of the options below:
  • "overwrite" - Current data will overwrite/replace all existing data for the same contact, within this PowerList. This also means that any blank fields will overwrite any existing fields.
    • (For example, say John Doe is already in the PowerList with an email address. If your API body includes no email, then the null email will overwrite/erase the existing email.)
  • "merge" - Current data will overwrite/replace the existing data for the same contact, only if that field is included. This means that any blank fields will be ignored, while any included fields will overwrite existing field data.
    • (For example, say John Doe is already in the PowerList with an email address and title. If your API body includes no email, then the existing email will not be changed.)
  • "ignore" - Current data will ignore duplicates and not replace any existing data. Use this if you want your older uploads to remain intact, such as if you intend to only add new contacts.
• "extraData" (optional) - You may submit your custom fields & custom data here - such as notes, an agent script, the client's internal account number, etc. The key value pair would be the column name and the value of the row in the column.

  • Example usage:

    "extraData": {
      "CustomerID": "1234-AB"
      "Favorite Ice Cream": "vanilla"
    }

Remove from PowerList

This request will allow you remove one or more contact from a specific PowerList. 

Request Body: 

{
    "businessid": "xxxxx",
    "target": ["+15854747501","+15854747502"],
    "eventname": "removefrompowerlist",
    "action": "removefrompowerlist",
    "powerlistId": "1969",
    "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
}

• "businessid" - Find this in your Kixie Dashboard, under Manage > Account Settings.
• "target" - The phone number you are updating for removal. You may use brackets [ ] to enter an array of multiple phone numbers. Most phone number formats will work fine, but for best results, use E.164 phone number format. (Example: 18005551234)
• "eventname"- Do not change. The value must be "removefrompowerlist".
• "action"- Do not change. The value must be "removefrompowerlist".
• "powerlistId" - Find this in your Kixie Dashboard, under Manage > PowerLists. Note that the I is capitalized.
• "apikey" - Your API key is already in the endpoint URL, but must be in the API body as well.

Remove from All PowerLists

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

⚠️ NOTE: Be aware that this checks each PowerList on your Kixie account, even ones that are inactive or unused. If you have dozens of PowerLists, then this action can quickly eat up your daily API usage limit of 10,000 API calls per day.

Please use with caution if you are using this on a large quantity of target numbers, or on a large number of existing PowerLists.

Request Body:

{
    "businessid": "xxxxxx",
    "target": ["+16123553857","+16123380085"],
    "eventname": "removefrompowerlist",
    "action": "removefromallpowerlists",
    "apikey": "xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

• "businessid" - Find this in your Kixie Dashboard, under Manage > Account Settings.
• "target" - The phone numbers you are updating for removal. You may use brackets [ ] to enter an array of multiple phone numbers. Most phone number formats will work fine, but for best results, use E.164 phone number format. (Example: 18005551234)
• "eventname"- Do not change. The value must be "removefrompowerlist".
• "action"- Do not change. The value must be "removefromallpowerlists".
• "apikey" - Your API key is already in the endpoint URL, but must be in the API body as well.