Getting Started

Welcome to the API documentation for our email warmup tool. This guide will walk you through the initial steps required to start using our API, including how to authenticate and make your first API request.

Obtaining an Authorization Key

To access our API, you need an authorization key, which acts as your API key. This key will be provided to you after we finalize the discussion regarding your pricing and integration details. Keep this key secure and do not expose it in publicly accessible areas such as GitHub or client-side code.

Base URL

The base URL for all API requests is: https://partners.leadwarm.ai/api/v1/

All endpoints documented here should be appended to this base URL.

Making Your First Request

To make requests to our API, include your API key in the header of each request as shown in the example below. This example demonstrates how to make a GET request to one of our endpoints.

await fetch("https://partners.leadwarm.ai/api/endpoint", {
    method: "GET",
    headers: {
        "Content-Type": "application/json",
        Authorization: "Bearer YOUR_API_KEY",
    },
});

Replace "YOUR_API_KEY" with the API key provided to you.

Additional Information

Content-Type: All requests should be made with the header "Content-Type: application/json".
Authorization: Ensure your API key is included in every API call for authentication.

By following these instructions, you should be able to start interacting with our API. For more detailed information on specific endpoints, please refer to the respective sections of this documentation.

Introduction Email