Access to the Valimail API is included with the Enforce Enterprise package. API access is available as a paid add-on for customers on Starter or Premium plans. If you are interested in purchasing this add-on, please contact your Account Manager.
API Keys are unique codes that allow access to a specific service or application. They are used as a unique identifier and provide a secret token for authentication purposes, which is used for requests made to the Valimail API endpoints. With the API Key Self-Service feature, customers can easily create and manage their API Keys without having to contact Product Support.
Access the API Key Self-Service page
Log in to your Enforce account at app.valimail.com.
Go to Account Settings (top right corner of the page).
Click on API KEYS.
Create an API Key
To create API keys, either Single Sign-On (SSO) or Multi-Factor Authentication (MFA) must be enabled. If neither of these security features is active, the 'Create API Key' button will be grayed out and the functionality disabled.
To create an API Key, follow these steps:
Click on CREATE API KEY.
Give a name to the key.
Select the Key Access (Configuration API, Reporting API, or both).
Click CREATE.
Save the Client ID and App ID in a secure location, as they will not be displayed again.
API Documentation
Click on the API SWAGGER DOCS button to access the documentation for the Configuration and Reporting APIs.
Access Permissions
Only Owner-type users have access to the API Key Self-Service page, along with permissions to create and revoke API Keys.
If you are a Member type user, or you do not have access to the Valimail account but need access to the Valimail APIs, reach out to your internal account admin to obtain API credentials for the specific APIs you wish to use.
When making your request, please specify which API you need access to:
Configuration API
Reporting API
Account Management (Partners Only)
Your Admin will supply the API key details required to create a bearer token.
If you’re unsure who serves as the account Admin, don't hesitate to contact [email protected] for help with the connectivity process.
For more information about the Valimail API, please visit the dedicated section in our knowledge base here.