The release of the Contact API for Employee Email enables you to sync user information from any REST API-enabled directory to your Email contacts and build custom distribution lists in the Email web app.

If your organization uses third-party tools other than Microsoft Entra ID or Workday to store internal contact information, you can leverage the Contact API for Employee Email to build a new integration. Previous experience working with APIs is recommended.

• Your synced contact information is kept up to date automatically on a regular schedule.
• Use your imported contacts to build custom distribution lists in the web app.
• Optionally, create custom fields to sync your organization's existing distribution lists directly from your third-party directory.
• You can set up multiple integrations using the Contact API to sync different collections of user data to Employee Email, or sync from different instances within your organization.
  

Prerequisites

• You have previous experience working with APIs.
  Staffbase recommends having a team of developers and/or IT experts to help build and maintain your integration.
• You have a Parent Admin account in Employee Email.
• Your organization uses the Email web app to send emails.
  If your organization has the Intranet and/or App solution(s) from Staffbase integrated with Employee Email and your contacts are already stored as App/Intranet users, save time by syncing users from your Staffbase App/Intranet.

Getting Started With the Employee Email Contact API

1. Sign into the Email web app.
2. Navigate to Contacts > Import.
3. Click the Contact API tile.
   
   
   
   The introduction page opens.
   It only displays when there is no existing Contact API configuration for your organization.
4. Click Continue.
   
   
   
   The Contact Fields tab opens.
5. Check the names of the seven Default Fields as well as any existing Custom Fields that may be used to map your contacts’ data.
   
   
   
   Optionally, edit existing custom fields or click Add Custom Field to map additional data about your contacts.
   
   
   
   
   Tip: To sync data about which existing third-party distribution lists your contacts belong to, create a custom field to represent each list that you want to sync.
   When your integration is set up, you can use these fields to filter your contacts and create custom dynamic distribution lists that contain only people who belong to your existing synced lists.
6. After making any changes to your custom fields, click Save and Update.
   Optionally, to see what your field names will look like when you use the API, you can click Download Sample JSON.
7. Click the API Keys tab to generate an API key.
   When your integration runs, this key will be used to authenticate your third-party application with Employee Email.
   
   
   
   
   Warning: 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.
8. Use the Contact API developer documentation to connect Employee Email to a third-party directory.
   Previous experience working with APIs is recommended.

Additional Helpful Information

• Uploading Email contact data via a comma-separated values (CSV) file
• Syncing Microsoft Entra ID (previously Azure AD) users as Email contacts
• Syncing Workday users as Email contacts
• Syncing Staffbase App/Intranet users as Email contacts