---
title: API Keys
description: The API Keys section allows you to create and manage authorization keys required when removing contacts from Contact Lists and Unsubscribe Lists via API.
---

[Skip to content](https://support.phonexa.com/api-keys#main-content)

[![phonexa\_logo-white](https://support.phonexa.com/hubfs/phonexa_logo-white.svg)](https://support.phonexa.com/?hsLang=en)

Open main navigation

Close main navigation

- [➜\]](https://phonexa.com/)

[➜\]](https://phonexa.com/?hsLang=en)

 Phonexa Support Center

- There are no suggestions because the search field is empty.

1. [Knowledge Base](https://support.phonexa.com/?hsLang=en)
2. [E-Delivery](https://support.phonexa.com/e-delivery?hsLang=en)
3. [List Management](https://support.phonexa.com/e-delivery?hsLang=en#list-management)

# API Keys

## The API Keys section allows you to create and manage authorization keys required when removing contacts from Contact Lists and Unsubscribe Lists via API.

- #### [**How to create an API key**](https://support.phonexa.com/api-keys#H1)

- #### [**How to remove a contact from Contact Lists**](https://support.phonexa.com/api-keys#H2)

- #### [**How to remove a contact from Unsubscribe Lists**](https://support.phonexa.com/api-keys#H3)

### **How to create an API key**

To view the list of **API Keys**, go to the **List Management \> Logs \> API Keys** section.

[![APIKeys11](https://support.phonexa.com/hs-fs/hubfs/APIKeys11.png?width=688&height=214&name=APIKeys11.png)](https://support.phonexa.com/hubfs/APIKeys11.png?hsLang=en)

You can narrow down the search results by using the following filters:

- **Name**: Enter the name of the API Key.

- **Status**: Select the status of the API Key *(Active, Disabled).*

The API Keyslistcontains the following information:

- **ID**: The unique identification number of the API Key.

- **Key**: The uniqueauthorization key of this API Key.

- **Name**: The name of the API Key.

- **Allowed Contact List Ids**:The Contacts List IDs available for deleting contacts via API.

- **Allowed Unsubscribe List Ids**: The Unsubscribe List IDs available for deleting contacts via API.

- **Created At**: The day and time when the API Key was created.

- **Status**: The status of the API Key (*Active, Disabled).*

To create an API Key, click the “**Add API Key**” button. In the “**Add API Key**” pop-up window, fill in the following data fields:

- **Name**: Enter the name of the API Key.

- **Status**: Select the status of the API Key (*Active, Disabled).*

- **Allowed Contact Lists**: Select the Contacts List IDs to be used when deleting contacts via API.   
  *Note: You may only select the list IDs with enabled API Access. Read more about how to create a contact list and set up API access in this Knowledge Base* [*article*](https://support.phonexa.com/en/articles/5747476-how-to-create-a-contact-list-and-set-up-api-access?hsLang=en)*.*

- **Allowed Suppression Lists**: Select the Unsubscribe List IDs to be used when deleting contacts via API.

Click the “**Add**” button to save the record.

![APIKeys22](https://support.phonexa.com/hs-fs/hubfs/APIKeys22.png?width=496&height=430&name=APIKeys22.png)

To edit the existing API Key, click the “**Edit**” button in the **“Actions”** column. In the “**Edit**” pop-up window fill in the following data fields:

- **Name**: Enter the name of the API Key

- **Status**: Select the status of the API Key (*Active, Disabled).*

- **Allowed Contact Lists**: Select the Contacts List IDs to be used when deleting contacts via API.   
  *Note: You may only select the list IDs with enabled API Access. Read more about how to create a contact list and set up API access in this Knowledge Base* [*article*](https://support.phonexa.com/en/articles/5747476-how-to-create-a-contact-list-and-set-up-api-access?hsLang=en)*.*

- **Allowed Suppression Lists**: Select the Unsubscribe List IDs to be used when deleting contacts via API.

![APIKeys33](https://support.phonexa.com/hs-fs/hubfs/APIKeys33.png?width=495&height=424&name=APIKeys33.png)

Click the “**Update**” button to confirm the changes.

### **How to remove a contact from Contact Lists**

To remove a contact from Contact Lists, follow the instructions provided in the list’s API Documentation required for making an API call. Please make sure that you have created an API Key with the corresponding Contact List IDs beforehand.

To access, go to the **List Management \> Contacts Lists** section, select the preferable contact list, and click the **“API Documentation”** button in the **“API”** column.

[![APIKeys44](https://support.phonexa.com/hs-fs/hubfs/APIKeys44.png?width=688&height=187&name=APIKeys44.png)](https://support.phonexa.com/hubfs/APIKeys44.png?hsLang=en)        

Compose a request using the guideline provided in the **“Deleting contacts from Contact Lists”** block of the documentation.

![APIKeys55](https://support.phonexa.com/hs-fs/hubfs/APIKeys55.png?width=685&height=207&name=APIKeys55.png)

Check the result of the request according to the provided response samples.

![APIKeys6](https://support.phonexa.com/hs-fs/hubfs/APIKeys6.png?width=424&height=310&name=APIKeys6.png)

Read more about the Contact Lists in this Knowledge Base [article](https://support.phonexa.com/en/articles/5725385-contacts-lists?hsLang=en).

### **How to remove a contact from Unsubscribe Lists**

To remove a contact from Unsubscribe Lists, follow the instruction provided in the list’s API Documentation required for making an API call. Please make sure that you have created an API Key with the corresponding Contact List IDs beforehand.

To access, go to the **Suppression Management \> Unsubscribe Lists** section, select the preferable unsubscribe list, and click the **“API Documentation”** button in the **“Actions”** column.

[![APIKeys77](https://support.phonexa.com/hs-fs/hubfs/APIKeys77.png?width=688&height=180&name=APIKeys77.png)](https://support.phonexa.com/hubfs/APIKeys77.png?hsLang=en)  
          Compose a request using the guideline provided in the **“Deleting contacts from Contact Lists”** block of the documentation.

![APIKeys88](https://support.phonexa.com/hs-fs/hubfs/APIKeys88.png?width=665&height=206&name=APIKeys88.png)  
Check the result of the request according to the provided response samples.

![APIKeys9](https://support.phonexa.com/hs-fs/hubfs/APIKeys9.png?width=431&height=302&name=APIKeys9.png)

Read more about the Unsubscribe Lists in this Knowledge Base [article](https://support.phonexa.com/en/articles/5839026-unsubscribe-lists?hsLang=en).

- [General information](https://support.phonexa.com/general-information?hsLang=en#main-content)

    - [Account Settings](https://support.phonexa.com/general-information?hsLang=en#account-settings)
    - [Security Settings](https://support.phonexa.com/general-information?hsLang=en#security-settings)
    - [Users](https://support.phonexa.com/general-information?hsLang=en#users)
    - [System Customization](https://support.phonexa.com/general-information?hsLang=en#system-customization)
    - [Project Customization](https://support.phonexa.com/general-information?hsLang=en#project-customization)
    - [Product Customization](https://support.phonexa.com/general-information?hsLang=en#product-customization)
    - [System Management](https://support.phonexa.com/general-information?hsLang=en#system-management)
    - [Support](https://support.phonexa.com/general-information?hsLang=en#support)
- [LMS Sync & Call Logic](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#main-content)

    - [Extra Features](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#extra-features)
    - [Publisher Configuration](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#publisher-configuration)
    - [Client Management](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#client-management)
    - [System Logs](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#system-logs)
    - [Documents And References](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#documents-and-references)
    - [Reports and Analytics](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#reports-and-analytics)
    - [Publisher management](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#publisher-management)
    - [Call Logic Customization](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#call-logic-customization)
    - [Campaign Configuration](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#campaign-configuration)
    - [Feed CMS](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#feed-cms)
    - [Event Tracking](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#event-tracking)
    - [iClear](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#iclear)
- [E-Delivery](https://support.phonexa.com/e-delivery?hsLang=en#main-content)

    - [List Management](https://support.phonexa.com/e-delivery?hsLang=en#list-management)
    - [Email Campaigns](https://support.phonexa.com/e-delivery?hsLang=en#email-campaigns)
    - [SMS Campaigns](https://support.phonexa.com/e-delivery?hsLang=en#sms-campaigns)
    - [Reports](https://support.phonexa.com/e-delivery?hsLang=en#reports)
    - [Suppression Management](https://support.phonexa.com/e-delivery?hsLang=en#suppression-management)
- [Books360](https://support.phonexa.com/books360?hsLang=en#main-content)

    - [Books 360 Integration](https://support.phonexa.com/books360?hsLang=en#books-360-integration)
    - [Vendor Management](https://support.phonexa.com/books360?hsLang=en#vendor-management)
    - [Account](https://support.phonexa.com/books360?hsLang=en#account)
    - [Customer Management](https://support.phonexa.com/books360?hsLang=en#customer-management)
- [Opt-Intel](https://support.phonexa.com/opt-intel?hsLang=en#main-content)

    - [List Management](https://support.phonexa.com/opt-intel?hsLang=en#list-management)
    - [All Reports](https://support.phonexa.com/opt-intel?hsLang=en#all-reports)
    - [Mailers](https://support.phonexa.com/opt-intel?hsLang=en#mailers)
    - [Campaigns](https://support.phonexa.com/opt-intel?hsLang=en#campaigns)
    - [System Management](https://support.phonexa.com/opt-intel?hsLang=en#system-management)
- [HitMetrix](https://support.phonexa.com/hitmetrix?hsLang=en#main-content)

    - [Analytics](https://support.phonexa.com/hitmetrix?hsLang=en#analytics)
    - [Heatmaps](https://support.phonexa.com/hitmetrix?hsLang=en#heatmaps)
    - [System Management](https://support.phonexa.com/hitmetrix?hsLang=en#system-management)
- [Lynx](https://support.phonexa.com/lynx?hsLang=en#main-content)

    - [Offers](https://support.phonexa.com/lynx?hsLang=en#offers)
    - [LYNX Reports](https://support.phonexa.com/lynx?hsLang=en#lynx-reports)
    - [Advertisers](https://support.phonexa.com/lynx?hsLang=en#advertisers)
    - [Affiliates](https://support.phonexa.com/lynx?hsLang=en#affiliates)
    - [Account Settings](https://support.phonexa.com/lynx?hsLang=en#account-settings)
- [Cloud PBX](https://support.phonexa.com/cloud-pbx?hsLang=en)

[![Phonexa\_logo\_color](https://support.phonexa.com/hubfs/Phonexa_logo_color.svg "Phonexa_logo_color")](https://phonexa.com/?hsLang=en)

Phonexa Knowledge Base

<https://www.facebook.com/phonexa/> <https://twitter.com/@phonexacalls> <https://linkedin.com/company/phonexa> <https://www.youtube.com/channel/UC4l-Pr8jkfqNTruWi6UlucQ/videos> <https://www.instagram.com/phonexa/>

Copyright © 2026, Phonexa