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 click Manage next to your chosen domain. In the API token section, 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.
You can access all domains that belong to your account.
Obtain activity logs of your domain.
Create and manage webhooks for listening to events and triggering actions.
Fetch and delete templates created on MailerSend.
Manage recipients on a suppressions list.
Once you have set the permissions, click on the Create token button.
Managing API tokens
Once you have created your token you can manage it from the API token section.
There are a few available options to manage your token:
Manage. You can rename the token if you need to at any point. Click Manage to open the pop-up, enter the new name and click Save. 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.
Pause. If you want to pause the token, click the drop-down arrow next to Manage and click Pause. 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.
Delete. In order to delete the token, click the drop-down arrow next to Manage and choose Delete. Before deleting the token you need to confirm it in the pop-up window.
API tokens page
API tokens are not restricted to specific domains, and can be used across all or multiple domains. You can view and manage all API tokens from the API tokens page, which is accessible from the main left-hand navigation menu under Settings.
Need more info?
Please feel free to contact us at firstname.lastname@example.org and a member of our support team will gladly assist you.