Pular para o conteúdo principal
POST
Create a pre-test

Autorizações

Authorization
string
header
obrigatório

API key, sent as Authorization: Bearer unite_live_.... Create keys in the workspace settings.

Cabeçalhos

Idempotency-Key
string
obrigatório

A unique value you generate for this request, 1 to 255 visible ASCII characters. A UUID works well. Keys are scoped to your workspace.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Accept-Language
string

Language of the result text when locale is not in the body. Defaults to pt.

Corpo

application/json
uploadId
string
obrigatório

The uploadId returned by POST /uploads, after you sent the file.

Minimum string length: 1
channel
string
obrigatório

Where the creative will run.

Allowed value: "ooh"
ooh
object
obrigatório
title
string

Name of the pre-test. A default is generated when omitted.

Required string length: 1 - 200
brandId
string

A brand id from GET /catalog. Enables the brand checks.

Required string length: 1 - 200
locale
enum<string>

Language of the result text. Defaults to Accept-Language, then pt.

Opções disponíveis:
pt,
en,
es
metadata
object

Up to 20 string key-value pairs that come back on the pre-test. Keys 1 to 40 characters, values up to 500. An empty object is the same as omitting it.

Resposta

Pre-test accepted.

id
string
obrigatório
object
string
obrigatório
Allowed value: "pretest"
status
enum<string>
obrigatório

queued: accepted and waiting to start. processing: being analyzed. completed: result available. failed: see error.

Opções disponíveis:
queued,
processing,
completed,
failed
channel
enum<string>
obrigatório
Opções disponíveis:
ooh,
digital,
email
title
string
obrigatório
locale
string
obrigatório

Language of the result text (pt, en or es).

createdAt
string
obrigatório

ISO 8601 UTC.

updatedAt
string
obrigatório

ISO 8601 UTC.

brand
object | null
obrigatório
creative
object
obrigatório
result
object | null
obrigatório

Present only when status is completed.

report
object
obrigatório
error
object | null
obrigatório

Present only when status is failed.

metadata
object
obrigatório

The key-value pairs sent on creation. Empty when none were sent.