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 use our API, or if you want to use some of our connectors such as dotmailer for Magento. 

Each API user has its own credentials (a username and password) that must be used to authenticate an operation/method call.

You can have more than one API user in a dotmailer account.

Creating 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 character. Please avoid including your email address or company name as part of your password.
  5. Select Enabled
  6. Click Save

The API user is 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 the Edit icon next to the user. On the 'Manage users' page, you can edit the description and password, plus you can disable and re-enable the user.

Click Save after making any changes.

Deleting an API user

Select the API user, and click Delete.

Note: 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, 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

Always be sure to double-check that you're using the correct username and password details when authenticating.

Disabled API user

Check that your API user is enabled.

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