1.0
OAS3
Welcome to the WarmUpInbox Customer API documentation. This comprehensive guide is crafted for developers, system integrators, and API enthusiasts looking to understand and leverage the capabilities of the WarmUpInbox Customer API.
API Endpoints: Dive deep into the specificities of each API endpoint. Each section provides clear explanations, request parameters, expected responses, and potential error codes. This ensures that you can seamlessly integrate and troubleshoot as needed.
Request & Response Schemas: Understand the structure of data flowing in and out of the API. Detailed schemas assist in crafting your requests and parsing the responses.
Integration Points: Whether you're building an integration for internal use, a third-party application, or a public-facing product feature, this documentation serves as a roadmap to ensure smooth development and deployment.
Postman Collection: For those who prefer using Postman for API development and testing, we've crafted a dedicated collection for you. This collection not only contains pre-configured requests for all our endpoints but also offers snippets of code for various programming languages including Node.js, Python, and more.
JSON Documentation: Access the WarmUpInbox Customer API documentation in JSON format. This is useful for those looking to integrate our documentation directly into their systems or for developers wanting a machine-readable version for various purposes.
Our WarmUpInbox Customer API offers different levels of functionality based on the subscription plan: Basic, Pro, and Max. Understanding these restrictions will help you optimize your usage of our API according to your plan.
Inbox Frequency Reply Rate: Control the rate at which your inbox replies.
Email Topics: Utilize AI-generated content for your emails, tailored to specific topics. This feature is available for:
Custom Templates: Create and use bespoke email templates to personalize your communication.
Inbox Schedule and Time zone: Define the sending schedule for your emails on a daily basis.
We're thrilled to have you here and look forward to seeing the innovative solutions you build using the WarmUpInbox Customer API. Should you have any questions or require further assistance, please don't hesitate to reach out to our support team.
Our service caters to two distinct user categories, each with a tailored billing approach:
B2B Users: Designed for business clients, our B2B model offers a flexible usage tracking system. Instead of immediate charges, we monitor your inbox usage throughout the month. At the end of each month, we generate a detailed invoice reflecting the total usage, ensuring transparent and post-usage billing. This model provides businesses with the flexibility to scale their usage without upfront costs.
Individual Users: For our individual users, we provide a straightforward immediate billing system. As soon as you use our services, charges are applied. This model is ideal for users who prefer a pay-as-you-go approach, offering simplicity and immediate transaction clarity.
To ensure fair usage and maintain the stability of our API for all users, we enforce a rate limit of 120 requests per minute. If you exceed this limit, your requests may be temporarily blocked until the rate limit resets. We recommend implementing proper error handling and retry logic in your application to manage this limit effectively.