Create Placement Test

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

or

Body Params application/jsonRequired

Example

{
    "name": "Q4 Campaign Test",
    "mailboxIds": [
        "mb_abc1",
        "mb_abc2"
    ],
    "emails": [
        "john@b2bforcelabs.com"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location '/v1/placement' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Q4 Campaign Test",
    "mailboxIds": [
        "mb_abc1",
        "mb_abc2"
    ],
    "emails": [
        "john@b2bforcelabs.com"
    ]
}'

Responses

🟢201

application/json

Placement test created successfully

Bodyapplication/json

Example

{
    "status": 201,
    "message": "Placement test created successfully.",
    "data": {
        "id": "plt_abc2",
        "name": "Q4 Campaign Test",
        "status": "completed",
        "report": {
            "inboxRate": 87.5,
            "spamRate": 12.5,
            "healthScore": 78,
            "healthLabel": "Good",
            "providers": [
                {
                    "provider": "Gmail",
                    "inboxRate": 90,
                    "spamRate": 10
                },
                {
                    "provider": "Outlook",
                    "inboxRate": 85,
                    "spamRate": 15
                }
            ]
        }
    }
}

🟠400

🟠401

🔴500