The API allows you to connect your application with Aimfox and automate different actions, such as sending messages, setting labels and notes for your leads, and even managing interaction limits for your accounts.
Documentation
This article will cover some general information about the API. For complete information regarding calls, routes, and the integration, please consult the documentation: https://docs.aimfox.com/
Setting up the API:
You can find your API settings by going to Workspace Settings > Integrations.
Configuration
The first step in using the Aimfox API is to authenticate your requests with an API key. You can create a new API key by clicking the "Create API Key" button on your Integrations page.
Creating your API key
Your API key must have a name and permission level. This can be configured when creating the key.
API key permission levels
"All" permission API keys can be used for all API calls.
"Read-only" API keys can only be used for GET calls and can generally be used to update your application with information from Aimfox, not the other way around.
Saving and using your API key
Once you generate your key, you will have the option to copy it and store it somewhere secure. This screen is your only chance to get a copy of your key.
API key management and restrictions
API keys can be managed on the Integrations tab of your workspace settings.
You can rename your API keys.
You can generate unlimited API keys.
API keys do not expire.
Keys can be deleted at any time.