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
To view the list of API Keys, go to the List Management > Logs > API Keys section.
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 Keys list contains the following information:
- ID: The unique identification number of the API Key.
- Key: The unique authorization 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.
- Allowed Suppression Lists: Select the Unsubscribe List IDs to be used when deleting contacts via API.
Click the “Add” button to save the record.
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.
- Allowed Suppression Lists: Select the Unsubscribe List IDs to be used when deleting contacts via API.
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 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 List Management > Contacts Lists section, select the preferable contact list, and click the “API Documentation” button in the “API” column.
Compose a request using the guideline provided in the “Deleting contacts from Contact Lists” block of the documentation.
Check the result of the request according to the provided response samples.
Read more about the Contact Lists in this Knowledge Base article.
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.
Compose a request using the guideline provided in the “Deleting contacts from Contact Lists” block of the documentation.
Check the result of the request according to the provided response samples.
Read more about the Unsubscribe Lists in this Knowledge Base article.
