Get Eligible Mailboxes for Placement Tests

Testing

POST

/v2/placement-tests/eligible-mailboxes

Retrieve a list of mailboxes eligible for placement testing. Allows filtering by status, tags, and search terms to find specific mailboxes.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zapmail.ai/api/v2/placement-tests/eligible-mailboxes?page=1&limit=10&status=ACTIVE' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success

application/json

Body

Example

{
  "status": 200,
  "message": "Eligible mailboxes retrieved successfully",
  "data": {
    "mailboxes": [
      {
        "id": "mailbox_abc123",
        "email": "user1@example.com",
        "username": "user1",
        "domain": "example.com",
        "domainId": "domain_xyz789",
        "status": "ACTIVE",
        "isWarmedUp": true,
        "tags": [
          {
            "id": "tag_abc123",
            "name": "Sales Team"
          }
        ],
        "createdAt": "2024-10-01T10:00:00.000Z",
        "assignedOn": "2024-10-01T10:00:00.000Z"
      },
      {
        "id": "mailbox_def456",
        "email": "user2@example.com",
        "username": "user2",
        "domain": "example.com",
        "domainId": "domain_xyz789",
        "status": "ACTIVE",
        "isWarmedUp": true,
        "tags": [
          {
            "id": "tag_def456",
            "name": "Marketing"
          }
        ],
        "createdAt": "2024-10-15T14:30:00.000Z",
        "assignedOn": "2024-10-15T14:30:00.000Z"
      }
    ],
    "totalCount": 25,
    "eligibleCount": 2
  }
}

🟠400Bad Request

🟠401Unauthorized

🔴500internal Server Error

Modified at 2026-01-12 09:48:32

Get report by cart order id

Get Available Placement Test Credits