API Guide

Create Design Test From Inbox Campaign

This API allows you to create a new Design test from a specific Inbox campaign. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: POST

Endpoint URL:


Sample Output:

    "status": "success"


Parameter Description Acceptable Values Required
id The Inbox campaign ID. Integer Y

Status Responses

Status Description
success 'status' => 'success' indicates that the test creation was successful.
failed 'status' => 'failed' indicates that the test creation failed.

Error Responses

Description Code Cause
Inbox campaign ID must be specified. 404 The unique identifier of the Inbox campaign is missing or invalid.
Invalid Inbox campaign ID. 404 The campaign ID must be numeric.
Test Not Found. 404 We couldn't find the Inbox campaign with your specified ID.
This test does not belong to you. 403 The campaign ID provided is not associated with your account.
You have already created X tests this month. 403 Your have reached your limit of Design tests.
NULL 401 Your API key does not have sufficient permission to access this endpoint.