Skip to main content
POST
/
v1
/
promotions
/
{promotionId}
/
versions
/
{versionId}
/
evaluate
Trigger evaluation
curl --request POST \
  --url https://public-api.adclear.ai/v1/promotions/{promotionId}/versions/{versionId}/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-External-User-ID: <x-external-user-id>'
{
  "evaluationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "processing",
  "correlationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Unkey API key passed as Bearer token

Headers

​
X-External-User-ID
string
required

External user identifier from the calling system

​
X-External-User-Email
string<email>

External user email from the calling system

Path Parameters

​
promotionId
string<uuid>
required

Promotion ID

​
versionId
string<uuid>
required

Version ID

Response

Evaluation triggered

​
evaluationId
string<uuid>
required
​
status
enum<string>
required
Available options:
processing
​
correlationId
string<uuid>
required

Correlation ID for request tracing. Include in support requests.