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 your account owner.

Contents

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

Summary

You'll 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'll only be able to access the API using 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 on the person-and-cog icon in the bottom left corner to produce the settings menu and select Access
    settings_select_access.png
  2. Select the API users tab (unless you're already in it)
  3. Click on New user
    new_API_user.png
  4. 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
  5. 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.
  6. Check the 'Enabled' box is ticked
  7. Click Save

The API user will be ready to use immediately.

Please 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 pencil 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 using the deleted email/password credentials, so be sure it's something you definitely want to do.

Troubleshooting authentication problems

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 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