Create Test

POST

https://api.inboxkit.com/v1/api/inbox-placement/tests

Maintainer:Not configured

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢201Test Created Successfully

application/json

Body

🟠400Bad Request

🟠402Insufficient Credits

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.inboxkit.com/v1/api/inbox-placement/tests' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sender_mailbox_ids": [
        "mailbox-uuid-123",
        "mailbox-uuid-456"
    ],
    "test_name": "Weekly Deliverability Check",
    "frequency": "once"
}'

Response Example

201 - Example 1

{
    "success": true,
    "test": {
        "id": "64f1a2b3c4d5e6f7g8h9i0j1",
        "test_code": "IPT-ABC123XYZ",
        "test_name": "Weekly Deliverability Check",
        "status": "pending",
        "sender_mailboxes": [
            {
                "email": "[email protected]",
                "platform": "GOOGLE",
                "profile_picture": "string",
                "full_name": "John Doe"
            }
        ],
        "receiver_mailboxes": [
            {
                "email": "string",
                "type": "string"
            }
        ],
        "created_at": "2025-01-15T10:30:00.000Z",
        "expires_at": "2025-01-15T11:30:00.000Z"
    },
    "schedule": {
        "id": "string",
        "frequency": "string",
        "next_run_at": "2019-08-24T14:15:22Z",
        "status": "string"
    },
    "billing": {
        "amount_charged": 0.1,
        "currency": "USD",
        "balance_remaining": 99.9
    }
}

Modified at 2025-11-20 17:16:23

Check Availability

List Tests