Overview
You'll learn what's available in Inframail's API documentation, including how to authenticate requests and the three email management operations you can perform. This article provides an overview of what you'll see once you subscribe and access the API documentation in your dashboard.
Prerequisites
Active Inframail subscription
Basic understanding of REST APIs and cURL commands
Compatibility
API access is available to all subscribed users. You can view the complete API documentation with your API key, credentials, and endpoint examples once you subscribe.
What's included in the API Access page
When you navigate to Subscription → View API Access in your dashboard, you'll see three main sections: your API key, your API variables, and the API documentation.
API Key section
This section displays your API key for programmatic access to Inframail.
What you'll see
API Key: Your unique authentication key (starts with
inf_)Created date: When your API key was generated
Last used date: When the key was most recently used in an API request
Copy Key button: One-click copy to clipboard
Keep this key secure. It provides full access to your account. Never share your API key publicly or commit it to version control.
Available Variables section
This section shows the credentials you'll need for API requests. All values have copy buttons for easy integration.
Customer ID
Your unique customer identifier. This is required for certain API operations, specifically when retrieving email account lists.
Profile ID
Your user profile identifier. This is required for all email management operations (create, delete, and retrieve).
Host Order IDs
A dropdown selector showing all your available hosts. Select a host to see its order ID, which you'll need when retrieving email accounts for a specific host.
All these values are pre-populated from your account and can be copied with a single click. No manual lookup required!
API Documentation section
The API documentation provides complete details about Inframail's API, including authentication requirements and all available operations.
Overview subsection
Explains that Inframail's API provides programmatic access to manage your hosting infrastructure, email accounts, DNS records, and domain configurations. The API is designed for external integrations and requires API key authentication.
Authentication subsection
Details how to authenticate your API requests using the API key in your request headers. The documentation includes example requests showing proper authentication format.
The example requests in the documentation use your actual API key and Profile ID, so you can copy and test them immediately without manual substitution.
Email Management subsection
Documents three operations for managing email accounts on your hosting infrastructure.
Create email accounts
Create new email accounts on your hosting infrastructure programmatically. This operation allows you to:
Create email accounts with custom passwords
Set optional display names for email accounts
Update passwords for existing email accounts
Choose whether to update the password if the email already exists
What you'll need
To create an email account, you'll provide:
Your profile identifier
The email address to create
A password for the new account
Optional: A display name
Optional: Whether to update the password if the email already exists
Use the password update option when you want to reset a password for an existing account instead of failing if the email already exists.
Delete email accounts
Remove email accounts programmatically when they're no longer needed. This operation permanently deletes the specified email account and all associated data.
What you'll need
To delete an email account, you'll provide:
Your profile identifier
The email address to delete
Deleting an email account is permanent and cannot be undone. All emails and data associated with that account will be permanently removed.
Retrieve email account lists
Fetch a complete list of all email accounts associated with a specific host. This operation helps you audit your email infrastructure, sync accounts with external systems, and maintain an accurate inventory.
What you'll need
To retrieve email accounts, you'll provide:
The host order ID for the host you want to query
Your customer ID
Your profile identifier
Use the Host Order IDs dropdown in the Available Variables section to find the ID for the specific host you want to query.
Using the API documentation
Copy buttons
Each code example and value in the documentation includes a copy button for quick access:
Copy Key: Copies your API key
Copy cURL Example: Copies authentication examples
Operation-specific copy buttons: Copy examples for each operation (create, delete, retrieve)
Pre-populated values
All example requests include your actual credentials automatically:
Your API key in request headers
Your Profile ID in request parameters
Your Customer ID where needed
This means you can copy the examples and test them immediately without manual editing.
The pre-populated examples make it easy to test the API right away. Just copy an example, paste it into your terminal, and you'll see real results from your account.
Request format
All API requests follow standard REST conventions:
Authentication
Every request must include your API key in the request headers. The documentation shows the exact header format to use.
Operation types
Create operations: Send data to create new email accounts
Delete operations: Remove existing email accounts
Retrieve operations: Fetch lists of email accounts
Data format
Create and delete operations send data in JSON format
Retrieve operations pass parameters in the request
All responses are returned in JSON format
Common use cases
Bulk email creation
Create dozens or hundreds of email accounts programmatically for campaigns or client onboarding, saving significant time compared to manual setup.
Email inventory management
Retrieve lists of all email accounts on each host for auditing or synchronization with external systems like CRM platforms or campaign tools.
Account cleanup
Remove email accounts that are no longer needed after campaigns end or clients churn, keeping your infrastructure clean and organized.
Platform integration
Integrate these operations with cold email platforms, CRM systems, or custom dashboards to automate email account management workflows.
Agency users often automate the entire workflow: create accounts via API, export them to cold email platforms, and delete them when campaigns complete—all without touching the dashboard.
How the documentation helps you
Complete request examples
For each operation, the documentation includes complete example requests with all required parameters clearly marked. You'll see which parameters are required and which are optional.
Parameter descriptions
Every parameter is documented with:
Parameter name
Data type (string, number, boolean)
Whether it's required or optional
What the parameter does
Real examples with your data
The documentation automatically fills in your actual credentials, so the examples work immediately when you copy them. You don't need to manually replace placeholder values.
This approach eliminates common setup errors and lets you verify your API access within minutes of subscribing.
Best practices
Secure your API key
Treat your API key like a password. Store it securely and never commit it to version control or share it publicly. The API key provides full access to manage your email accounts.
Validate before deleting
Before deleting email accounts, verify that you have the correct email address. Consider implementing a confirmation step in your automation to prevent accidental deletions.
Handle errors gracefully
Implement proper error handling in your integration to manage situations like network timeouts, invalid credentials, or accounts that already exist.
Use meaningful naming conventions
When creating email accounts in bulk, use consistent and meaningful naming conventions that make it easy to identify the purpose of each account.
Consider building a wrapper function around the API that includes validation, error handling, and logging to make your integration more robust and maintainable.
What's next
Subscribe to Inframail to access the complete API documentation with your credentials
Build your integration using the documented operations
Getting help
If you encounter issues with the API:
Verify your API key is correct and hasn't been regenerated
Check that all required parameters are included in your request
Ensure you're using the correct operation type for your task
Contact Inframail support with the error message and operation you're attempting
When contacting support about API issues, include the HTTP status code and error message you received. This helps the team diagnose problems quickly.