Skip to main content
POST
Set a campaign's A/B variants

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

id
string
required

Body

application/json
variants
object[]

Full replacement variant set. Each variant needs a unique variant_index.

Required array length: 2 - 4 elements
ab_winner_metric
enum<string>

Metric used to pick the winning variant.

Available options:
delivered,
opened,
clicked,
replied
ab_holdout_percent
integer

Percentage of the audience withheld from all variants as a control group.

Required range: 1 <= x <= 50
ab_bandit
boolean

Enable multi-armed bandit (Thompson) auto-optimization — traffic shifts toward leading variants mid-send instead of an even split.

Response

The resulting variant set.

data
object
meta
object