Using the API for the Seedlist

The Warmy Seedlist API allows you to programmatically manage your email warm-up seed lists, including retrieving data, managing approved senders, and downloading seedlists. Below is a step-by-step guide to using the API’s key features.

{
    "users_split": {
        "users_splits_senders_attributes": [
            {
                "id": 456,
                "email": "new_seed@domain.com",
                "_destroy": false
            }
        ]
    }
} 

Using Warmy with an API

Warmy provides an API that allows you to manage your Seed list programmatically. This can be useful for automating tasks or integrating Warmy with other applications.

Prerequisites

Before you can use the API, you need to already be registered on warmy.io 

Server

The Warmy API is available at https://api.warmy.io.

Important Update: Transition from "Sign in" to API_KEY

What You Need to Do:

• For generating your API_KEY, contact Customer Success or Support.
• Use API_KEY in your API requests moving forward.

How to Use API_KEY:

• Add the following headers to all API V2 requests:

  • Authorization: Bearer your_token ( your_token = API_KEY)

  • holder-uid: a66a9a755fe16f24fcb99dc8b5f25a50

❗Important:

• Do not use the following parameters if you are using API_KEY:

  • client

  • access-token

  • uid

Sign in

❗You will receive access-token, uid, and client in response headers

Include these headers in all subsequent API requests

/api/v1/auth/sign_in

Headers:

holder-uid * (a66a9a755fe16f24fcb99dc8b5f25a50)

Example of a request body (JSON):

{
  "email": "string",
  "password": "string"
}

1. Retrieve Seed Lists

/api/v2/users_splits 

Headers

Query Parameters

Example Response:

{  
  "users_splits": [  
    {  
      "id": 123,  
      "last_download": "2025-03-25",  
      "seeds_amount": 500,  
      "possible_senders_amount": 1000,  
      "provider": "Gmail",  
      "group_name": "premium"  
    }  
  ]  
}  

2. Get Specific Seed List

Headers

Path Parameter

Example Response:

{  
  "id": 123,  
  "senders_list": [  
    {  
      "id": 456,  
      "email": "seed1@domain.com",  
      "domain": "domain.com"  
    }  
  ],  
  "seeds_amount": 500  
}  

3. Update Seed List

Headers

Path Parameter

Request Body

To add a sender email, use the following format:

{  
  "users_split": {  
    "users_splits_senders_attributes": [  
      {  
        "id": 456,  
        "email": "new_seed@domain.com",  
        "_destroy": false  
      }  
    ]  
  }  
}  

{  
  "users_split": {  
    "users_splits_senders_attributes": [  
      {  
        "id": 456,  
        "email": "new_seed@domain.com",  
        "_destroy": true  
      }  
    ]  
  }  
}  

4. Retrieve Seed List Emails

Headers

Query Parameters

Response:

{  
  "items": ["seed1@domain.com", "seed2@domain.com"],  
  "pagination": {  
    "current_page": 2,  
    "total_pages": 5  
  }  
}  

Key Parameters

Need help? Contact hi@warmy.io

Why Use the API?

• Automation: Manage splits and senders programmatically.

• Scalability: Handle large volumes of splits and seeds efficiently.

• Integration: Seamlessly integrate seedlist data into your email workflows.