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.
The API also supports campaign-related functionalities such as lead syncing, profile addition, and integration with external systems, while certain advanced tasks like full campaign setup and detailed analytics require the Aimfox dashboard.
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/
API Capabilities and Limitations
The Aimfox API supports several functionalities that can streamline your campaign processes. These include:
Integration with external systems: The API allows seamless integration with other tools and platforms to sync leads and data efficiently.
Basic campaign automation: You can use the API to automate certain aspects of your campaigns, such as adding profiles or syncing leads.
Tasks Supported by the API
While the API offers robust features, its scope is limited to specific tasks, such as:
Lead syncing: Automatically sync leads from external sources into your Aimfox campaigns.
Profile addition: Add profiles to your campaigns programmatically using the API.
Tasks Requiring the Aimfox Dashboard
For more comprehensive campaign management, you will need to use the Aimfox dashboard. Tasks that cannot be performed via the API include:
Full campaign setup: Creating and configuring campaigns from scratch must be done through the dashboard.
Advanced campaign management: Features such as detailed analytics, advanced targeting, and campaign optimization are accessible only through the dashboard.
Setting up the API:
You can find your API settings by going to Workspace Settings > API keys.
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.
