API Guide

Create Design Test

This API allows you to create a new Design test. 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",
    "id": "20136334"


Parameter Description Acceptable Values Required
subject The subject of the test. String Y
html The raw HTML of the test. String Y
text The text version of the test. String N

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
Form Validation 404 We will return an array of errors if there are form validation issues, i.e. an invalid email address
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.