Managing the API key for Employee Email

Learn how to generate or delete the API key for Employee Email.

Employee Email

For third-party services to establish communication with Employee Email, you can create an API key in the web app or in Email integrated with the Studio. The key is a set of two credentials:

  • Auth ID
  • Access key

You can only have one API key for Employee Email at a time. It is used in all API-based Email integrations. The only way to generate a new key is to replace the existing one.

  • You have a Parent Admin account in Employee Email.
  • Contact API is enabled for your organization. Ask your Customer Success Manager for details.
  1. In the Employee Email web app, or in Email integrated with the Studio, go to your Email Contacts.
  2. Navigate to Import > Contact API > API Keys.
  3. Click Generate API Key.

A new Auth ID and Access Key are generated. 4. Click the copy icon next to the Auth ID or Access Key to copy to the clipboard.

You can use the copied credentials to establish communication between third-party services and the Employee Email Contact API.

Keep your API key confidential and do not share it with anyone. It can be used to view and modify your contacts with the same level of access as a Parent Admin.

You can have only one API key for Employee Email at a time and use it in all API-based Email integrations. The only way to generate a new key is to replace the existing one.

Deleting an API key removes it permanently and affects all API-based integrations using that key. If you need to replace your API key, ensure that you update the Auth ID and Access Key in any third-party platforms for uninterrupted integration.

  1. In the Employee Email web app, or in Email integrated with the Studio, go to your Email Contacts.
  2. Navigate to Import > Contact API > API Keys.
  1. Click the three dots on the API key that you want to delete.
  2. Click Delete API Key.

The existing credentials are deleted. They can no longer be used to maintain communication between third-party services and the Employee Email API.