Resume A/B Test - Sequenzy

POST

api

ab-tests

{abTestId}

resume

Resume A/B Test

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

import requests

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

payload = { "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({confirmLiveChange: true})
};

fetch('https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/resume', 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}/resume",
  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([
    '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}/resume"

	payload := strings.NewReader("{\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}/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirmLiveChange\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"confirmLiveChange\": true\n}"

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

{
  "success": true,
  "abTest": {
    "id": "ab_abc123",
    "kind": "sequence",
    "status": "testing",
    "winningVariantId": null,
    "autoSelectWinner": false
  }
}

{
  "success": false,
  "error": "Resuming an A/B test in an active sequence requires confirmLiveChange=true"
}

Resume a sequence A/B test that already has a winner, for example one picked automatically before you were sure. The winner is cleared and contacts who reach the step are split across the variants again. Results collected so far are kept, and contacts who already got a variant keep it. Automatic selection is turned off for the test (autoSelectWinner: false), so it keeps splitting until you choose a winner with Select A/B Test Winner. You can turn it back on with autoSelectWinner: true on Update A/B Test. The test returns to testing, so its variants stay fixed until a winner is selected. Repeating the request is safe.

Request

string

required

Sequence A/B test ID.

boolean

Required as true when the sequence is active, because contacts reaching the step are split again from then on. Not needed to repeat a resume that already applied.

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

The API key needs ab_tests:write and sequences:write.

Responses

{
  "success": true,
  "abTest": {
    "id": "ab_abc123",
    "kind": "sequence",
    "status": "testing",
    "winningVariantId": null,
    "autoSelectWinner": false
  }
}

{
  "success": false,
  "error": "Resuming an A/B test in an active sequence requires confirmLiveChange=true"
}

400 also covers campaign tests, completed or cancelled tests, a test that is no longer attached to its step, and a test with fewer than two variants; 401/403 cover authentication, scope and role restrictions; 404 means the test is unavailable.

Resume A/B Test

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

import requests

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

payload = { "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({confirmLiveChange: true})
};

fetch('https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/resume', 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}/resume",
  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([
    '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}/resume"

	payload := strings.NewReader("{\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}/resume")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirmLiveChange\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"confirmLiveChange\": true\n}"

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

{
  "success": true,
  "abTest": {
    "id": "ab_abc123",
    "kind": "sequence",
    "status": "testing",
    "winningVariantId": null,
    "autoSelectWinner": false
  }
}

{
  "success": false,
  "error": "Resuming an A/B test in an active sequence requires confirmLiveChange=true"
}

​Request

​Responses

Request

Responses