Create and manage scoped API keys

Paubox manages API keys through scopes, so you can create, edit, and revoke keys for the Paubox Email API, Paubox Marketing, and Paubox Forms from one place. A scope defines what a key can access, which lets you give each key only the access it needs.

How scopes work

Every API key carries one or more scopes. The scope determines which product the key can authenticate to:

• Email API

• Paubox Marketing

• Paubox Forms

A single key can carry the Email API scope or the Paubox Marketing scope, but not both. You can add the Paubox Forms scope alongside either one.

When you create a key, the domain picker automatically shows only the domains that match the scope you selected, so you always pair a key with a valid sending domain.

How to create an API key

1. Log in to your Paubox dashboard

2. Go to Settings > API keys

3. Select Add API key

4. Choose a scope: Email API, Paubox Marketing, Paubox Forms. 

5. Select the sending domain for the key. The picker lists only the domains that match the scope you chose

6. Enter a name that describes how the key will be used

7. Select Add API key, then copy the key and store it somewhere secure

How to edit or delete a key

You can manage every key from the same Settings > API keys page.

• To edit a key, open it from the list, update its details, and save your changes.

• To revoke a key, select it from the list and click Revoke. Revoking stops the key from authenticating right away, so confirm it is no longer in use first.

Use the scope and domain filters at the top of the list to find a specific key.