Creating an API key
API keys let you authenticate with the EmailShepherd API.
Who can create an API key
Section titled “Who can create an API key”Users with the admin or developer role can create API keys. If your organization uses custom roles, anyone with the manage_api_keys permission can create them.
Creating a key
Section titled “Creating a key”Go to Organization Settings > API Keys, then click Create API key.
Give your key a name that describes what it’s for, so you can recognise it later.
Choosing scopes
Section titled “Choosing scopes”Each key has a set of scopes: the actions the key is allowed to perform. The available actions are grouped by resource (Emails, Projects, Image library, and so on), and most offer Read, Write, and Delete.
An API key can do exactly what its scopes allow, and nothing more.
Copying your key
Section titled “Copying your key”Once you’ve named the key and chosen its scopes, click Create.
Your new key is shown once. Copy it and store it somewhere safe, because you won’t be able to see it again.
Next steps
Section titled “Next steps”See Authentication for how to use your key to make requests, and the API reference for the full list of available endpoints.