Start a form A/B setup
Start a form A/B test by ID. Launches the A/B setup so its variants begin serving to visitors according to their weights, moving the setup to enabled status. Starting a form A/B setup that has already been started returns a conflict.
An optional auto-close policy can be supplied in the request body. endsAt closes the test at a fixed instant and must be in the future. stopOnSignificance closes the test as soon as one variant is a statistically significant winner; on its own it is subject to a seven-day minimum runtime. Supply at least one of the two, or omit autoClose entirely for a test that never closes automatically. The policy cannot be changed after the test has started.
Scopes: forms.write
Rate Limiting: This endpoint is rate limited to 400 requests per minute.
Request
- Base URLhttps://api.omnisend.com/api
- URLhttps://api.omnisend.com/api/form-ab-setups/{abSetupID}/start
- Auth
- OAuth 2Client credentialsToken URL: https://app.omnisend.com/oauth2/token scopes: forms.write
- or API key in header Authorization
Path parameters
Form A/B setup ID
Headers
API version that specifies the response format and behaviour
Request body
Example request
{
"autoClose": {
"endsAt": "2026-09-30T23:59:59Z",
"stopOnSignificance": true
}
}Response
Form A/B test started
Changes
No recorded changes to this operation across all 1 revision of this API.