Skip to main content

Create and manage API keys

API keys let your developers authenticate to the platform's APIs — for example, to send transactional email, sync subscribers, or pull report data. Each key is a secret credential tied to your account, so treat it like a password: issue keys deliberately, scope them narrowly, and revoke any that are no longer needed.

Before you begin​

  • You need an admin role with permission to manage account access.
  • Decide what the key will be used for so you can name it clearly (for example, "Prod transactional send") and pick the right scope if scopes are offered.
  • Have a secure place to store the key. It is shown only once at creation and cannot be retrieved later.
  • Know that revoking a key takes effect immediately and will break any integration still using it.

Steps​

  1. Open the account or admin settings area and go to the API keys section (confirm the exact steps in your account).
  2. Choose the option to create a new key.
  3. Give the key a descriptive name, and set its scope or permissions if those options are available.
  4. Generate the key, then copy the secret value and store it securely right away.
  5. Hand the key to your developer through a secure channel — never email or paste it into a shared document.
  6. To revoke a key, find it in the list and select the revoke or delete action; to rotate, create a new key first, update the integration, then revoke the old one.

Result​

The new key appears in your API keys list with its name and creation date. Your developers can now authenticate their integration using it, and you can revoke it at any time to cut off access.

Canonical terms: Author, Edition, Folder (Project Folder), Broadcast. See the Glossary.