Create a form A/B setup

Create a draft form A/B setup from an existing popup, flyout or fullscreen form. Only those display types are eligible;
the source form becomes the setup's main form and its two variants start as identical copies that can be edited
independently afterward. The setup is created in draft status and does not serve traffic until started via
POST /form-ab-setups/{abSetupID}/start.

Each variant carries a traffic-distribution weight. When versions is omitted, both variants receive a weight
of 50; otherwise each weight must be at least 1 and the weights must sum to 100.

Scopes:
forms.write

Rate Limiting:
This endpoint is rate limited to 400 requests per minute.

Body Params

Form A/B setup to create

Request to create a draft form A/B setup.

string
required

Main form unique identifier

versions
array of objects
length between 2 and 2

Two competing form variants. When omitted, both variants use a weight of 50

versions

Form A/B setup version to create.

string

Variant form name

integer
1 to 99

Traffic distribution weight. Each weight must be at least 1 and both weights must sum to 100

Form A/B setup version to create.

string

Variant form name

integer
1 to 99

Traffic distribution weight. Each weight must be at least 1 and both weights must sum to 100

Headers
string
required
Defaults to 2026-preview

API version that specifies the response format and behaviour

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json