Managing API tokens

API tokens are used for authentication when sending emails or accessing server-specific endpoints. They’re the preferred alternative to using a username and password, as you can revoke an API token at any time and use different permissions.

Tokens are generated under your domains, but you can access other domains using the same token that belongs to your account too.

Creating API tokens

To generate an API token, go to Domains and choose your domain. Scroll down to the API token area and click on the Generate new token button. In the pop-up window, you can create your API token.

First you need to name your token. You're free to use any name you want, as long as it’s clear to you.

API tokens can have different permissions. At MailerSend, you can choose between Full access and Custom access permissions.

  • Full access allows the API token to access GET, PUT, DELETE and POST endpoints for all parts of your account. It's the most powerful access option, so use it carefully. 

  • Custom access allows you to choose which access to provide for the token.

API access

No access

Read only

Full access

Email
The main API endpoint for sending emails through MailerSend.

X

Domains

You can access all domains that belong to your account.

X

Activity

Obtain activity logs of your domain.

X

Analytics
Obtain accumulated data of your sendings.

X

API tokens
Create, update or delete API tokens.

X

Once you have set the permissions, click on the Create token button.

Important: For security reasons, you will only be shown your API token one time, so please copy or download this key and save it somewhere safe.

Managing API tokens

Once you have created your token you can manage it. All available tokens are listed under the API token area.

There are a few available options to manage your token:

  • Pause. If you want to pause the token, click Pause on the action button on the right. This action pauses your access token immediately—all of the applications or users won't be able to use it (access your account) until you resume it by clicking the Resume button. 

  • Rename token or View permissions. You can rename the token in order to make the name more clear. Click the arrow on the action button and choose Edit. In the same pop-up, you can also see what permissions are given for this token. If you want to change the permissions, you need to delete the existing token and create a new one.

  • Delete token. In order to delete the token, click the arrow on the action button and choose Delete. Here you can delete a key. Before deleting the token you need to confirm it in the pop-up window.