Select A/B Test Winner

POST

api

ab-tests

{abTestId}

select-winner

Select A/B Test Winner

curl --request POST \
  --url https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variantId": "<string>",
  "confirmLiveChange": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner"

payload = {
    "variantId": "<string>",
    "confirmLiveChange": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variantId: '<string>', confirmLiveChange: true})
};

fetch('https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'variantId' => '<string>',
    'confirmLiveChange' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner"

	payload := strings.NewReader("{\n  \"variantId\": \"<string>\",\n  \"confirmLiveChange\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variantId\": \"<string>\",\n  \"confirmLiveChange\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variantId\": \"<string>\",\n  \"confirmLiveChange\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "abTest": {
    "id": "ab_abc123",
    "status": "winner_selected",
    "winningVariantId": "var_b"
  }
}

{
  "success": false,
  "error": "Another winner was selected at the same time"
}

Select a variant as the winner of a campaign or sequence A/B test.

Campaign tests must be in the testing phase. Selection immediately queues winner delivery for the remaining audience. Repeating the same selection safely repairs an interrupted queue operation; selecting a different winner returns a conflict.
Sequence tests can be in any phase except completed or cancelled. You can also change a winner that was already selected, including one picked automatically after the test reached its winnerThreshold and one variant led on the winning metric. The test needs at least two variants. Everyone who reaches the step from then on gets the new winner. Contacts who already got a variant keep it. Only the test currently attached to its sequence step can be changed. Repeating the same selection returns 200 without changing winnerSelectedAt. The response abTest has the same shape as Get A/B Test.

Request

string

required

Campaign or sequence A/B test ID.

string

required

Variant ID to select as the winner.

boolean

Sequence tests only. Required as true when the sequence is active, because the new winner goes to everyone who reaches the step from then on. Not needed to repeat the current winner. Campaign tests ignore it.

curl -X POST "https://api.sequenzy.com/api/v1/ab-tests/ab_abc123/select-winner" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"variantId":"var_b"}'

The API key needs ab_tests:write. Campaign tests also need campaigns:send; sequence tests also need sequences:write.

Responses

{
  "success": true,
  "abTest": {
    "id": "ab_abc123",
    "status": "winner_selected",
    "winningVariantId": "var_b"
  }
}

{
  "success": false,
  "error": "Another winner was selected at the same time"
}

For campaign tests, a pending audience change returns 409. Wait for it to apply, or discard a failed change before selecting your winner. You can record a winner while paused; delivery waits until you resume the campaign. If queue publication returns 500 after selection, GET the test and repeat the same winner ID. That retry repairs delivery without changing the winner or resending committed recipients. 400 covers an invalid phase, a missing or inactive campaign, a sequence test that is no longer attached to its step or has only one variant, or a missing confirmLiveChange for an active sequence; 401/403 cover authentication, scope and role restrictions; 404 means the test or the requested variant is unavailable.

Select A/B Test Winner

curl --request POST \
  --url https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variantId": "<string>",
  "confirmLiveChange": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner"

payload = {
    "variantId": "<string>",
    "confirmLiveChange": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variantId: '<string>', confirmLiveChange: true})
};

fetch('https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'variantId' => '<string>',
    'confirmLiveChange' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner"

	payload := strings.NewReader("{\n  \"variantId\": \"<string>\",\n  \"confirmLiveChange\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variantId\": \"<string>\",\n  \"confirmLiveChange\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/select-winner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variantId\": \"<string>\",\n  \"confirmLiveChange\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "abTest": {
    "id": "ab_abc123",
    "status": "winner_selected",
    "winningVariantId": "var_b"
  }
}

{
  "success": false,
  "error": "Another winner was selected at the same time"
}

​Request

​Responses

Request

Responses