How to create an API user

Created by Hannah Peters, Modified on Mon, 21 Aug, 2023 at 11:03 AM by Hannah Peters

An API user is used for accessing Connectels powerful API, if you want to build features and integrations around the Connectel plattform, e.g. an Email form on your website which creates an Email interaction in Connectel and adds all details from the Email form on your website to the customer card in Connectel. The reason you want to create a separate user is to have a dedicated user for the API-key. If you use the API key from any other user you risk losing the integration when e.g. the user is removed because they're not using the platform anymore.

The user should be named yourcompany.api, to avoid risking that the user is removed.

How to create an API user

1. Make sure you have the right amount of User licenses. If you have used all your licenses contact your Account Manager or Customer Success Manager.

2. Go to Staff -> Users, click the + in the bottom right corner. Select Admin or User depending on your preferences. The Admin API key will have full access to the entire system while the User type can be fine grained to limit access to specific parts of the system.

Click Add User.

3. Click the three dots next to the user and then Edit

4. Click here to generate your API Key:

5. Under Account you can find and copy your API Key:

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article