How do I create an API user?

You'll need the correct permission to create an API user

Only an account owner (or a user with the 'Can manage account' permission) can add API users. If you can't complete the process below, or if some of the options don't appear to you, then contact us.

Contents

Steps to create your API user
   » Editing/disabling an API user
   » Deleting an API user
   » Troubleshooting authentication problems

Summary

You need an API user if you want to make use of our API or some of our connectors and integrations that access our API, such as dotmailer for Magento. 

API user credentials are made up of a username and password, and are required to authenticate each operation/method call that's made and to make sure you're connected to the correct account.

You can access the API only with these credentials, although you can have more than one API user per dotmailer account.

Follow the simple steps below to set one up.

Steps to create an API user

  1. Click the person-and-cog icon in the bottom left corner and go to Access > API users
    settings_select_access.png
  2. Click New user
    new_API_user.png
  3. The username (email address) is automatically generated for you and must not be edited. You can add a description to differentiate between API users, which is useful if you have multiple ones.
    manage_API_user.png
  4. Enter a password and confirm it. Your password must be at least eight characters in length and contain at least one digit or non-alphanumeric. Also please avoid including your email address or company name as part of your password.
  5. Check the 'Enabled' box is ticked
  6. Click Save

The API user will be ready to use immediately.

Note: When creating API users, it's best practice to create one user per system (for instance, one for a Magento integration and another one for a Dynamics integration) and not share an API user for different integrations. This makes it easier to revoke individual API users should you need to, as well as isolate and diagnose problems with integrations.

Editing/disabling an API user

To disable or edit an API user, click on the Edit icon next to the user. This will take you to the 'Manage users' page where you can edit their description and password, plus you can disable and re-enable them.

Click Save after making any changes.

Deleting an API user

To do this, simply tick the API user that you wish to delete and click Delete.

Remember - deleting an API user will disable any functionality that uses the deleted credentials, so be sure it's something you definitely want to do.

Troubleshooting authentication problems

Important

Your API user will become locked in either of the following circumstances:

  • You enter an invalid password for an API user five times
  • Your account is disabled

To unlock an API user, follow the steps to reset your password. You can either enter a new password or enter the old password if you remember it.

If your disabled account is re-enabled, you'll need to unlock your API user in the same way.

Incorrect credentials will normally be the most likely reason for unsuccessful authentication. Always be sure to double-check that you're using the correct username and password details when authenticating.

It may also be the case that the API user is not enabled. Ensure that they are before continuing.

If, after double-checking, the problem persists despite the fact that you think you're using the correct details and the API user is enabled, we'd recommend deleting the API user and creating a new one just to make absolutely sure.

Read more about dotmailer's API in our developer hub »
Have more questions? Submit a request

Comments