cURL

curl --request PATCH \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": 4,
  "variants": [
    {
      "agentId": "agent_1ffdb9717444d0e77346838911",
      "weight": 70
    },
    {
      "agentId": "agent_7c4e1b28f0a94d6591cc2fd340",
      "weight": 30
    }
  ]
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test"

payload = {
    "revision": 4,
    "variants": [
        {
            "agentId": "agent_1ffdb9717444d0e77346838911",
            "weight": 70
        },
        {
            "agentId": "agent_7c4e1b28f0a94d6591cc2fd340",
            "weight": 30
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    revision: 4,
    variants: [
      {agentId: 'agent_1ffdb9717444d0e77346838911', weight: 70},
      {agentId: 'agent_7c4e1b28f0a94d6591cc2fd340', weight: 30}
    ]
  })
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test', 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.teamfollowup.ai/api/agent-builder/agents/{id}/split-test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'revision' => 4,
    'variants' => [
        [
                'agentId' => 'agent_1ffdb9717444d0e77346838911',
                'weight' => 70
        ],
        [
                'agentId' => 'agent_7c4e1b28f0a94d6591cc2fd340',
                'weight' => 30
        ]
    ]
  ]),
  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.teamfollowup.ai/api/agent-builder/agents/{id}/split-test"

	payload := strings.NewReader("{\n  \"revision\": 4,\n  \"variants\": [\n    {\n      \"agentId\": \"agent_1ffdb9717444d0e77346838911\",\n      \"weight\": 70\n    },\n    {\n      \"agentId\": \"agent_7c4e1b28f0a94d6591cc2fd340\",\n      \"weight\": 30\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"revision\": 4,\n  \"variants\": [\n    {\n      \"agentId\": \"agent_1ffdb9717444d0e77346838911\",\n      \"weight\": 70\n    },\n    {\n      \"agentId\": \"agent_7c4e1b28f0a94d6591cc2fd340\",\n      \"weight\": 30\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"revision\": 4,\n  \"variants\": [\n    {\n      \"agentId\": \"agent_1ffdb9717444d0e77346838911\",\n      \"weight\": 70\n    },\n    {\n      \"agentId\": \"agent_7c4e1b28f0a94d6591cc2fd340\",\n      \"weight\": 30\n    }\n  ]\n}"

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

{
  "success": true,
  "splitTest": {
    "locationId": "loc_9f7a123",
    "campaignId": "campaign_speed_to_lead_123",
    "primaryAgentId": "agent_1ffdb9717444d0e77346838911",
    "status": "active",
    "revision": 5,
    "sync": {
      "status": "healthy",
      "failedAt": null
    },
    "variants": [
      {
        "agentId": "agent_1ffdb9717444d0e77346838911",
        "name": "Speed to Lead",
        "sequence": 1,
        "weight": 70,
        "status": "active",
        "addedAt": "2026-08-14T09:12:44.318Z",
        "removedAt": null,
        "isPrimary": true
      },
      {
        "agentId": "agent_7c4e1b28f0a94d6591cc2fd340",
        "name": "Speed to Lead II",
        "sequence": 2,
        "weight": 30,
        "status": "active",
        "addedAt": "2026-08-20T16:04:02.771Z",
        "removedAt": null,
        "isPrimary": false
      }
    ]
  }
}

Update split weights

Shift traffic between the variants, and decide which of them are in the cycle at all.

Send every variant in the split exactly once, along with the revision you read. A weight of 0 excludes that variant: it stays a member and stays testable, but takes no calls, and a live variant covers its leads until it is back. Any weight from 1 puts it back in, and the weights of the live variants must total 100.

Inclusion travels with the weight rather than through its own endpoint because including an arm necessarily moves the others, and the two have to land together or the split spends a moment with something live at a share nobody chose.

Partial submissions are rejected rather than merged, both because a weight only means something relative to the others and so that a dropped variant is an error rather than a silent exclusion.

The Primary Variant cannot be excluded: it is the campaign’s own agent and the fallback for every route. At least one variant must always be live.

Required API key scope: agents:write.

PATCH

api

agent-builder

agents

{id}

split-test

cURL

curl --request PATCH \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "revision": 4,
  "variants": [
    {
      "agentId": "agent_1ffdb9717444d0e77346838911",
      "weight": 70
    },
    {
      "agentId": "agent_7c4e1b28f0a94d6591cc2fd340",
      "weight": 30
    }
  ]
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test"

payload = {
    "revision": 4,
    "variants": [
        {
            "agentId": "agent_1ffdb9717444d0e77346838911",
            "weight": 70
        },
        {
            "agentId": "agent_7c4e1b28f0a94d6591cc2fd340",
            "weight": 30
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    revision: 4,
    variants: [
      {agentId: 'agent_1ffdb9717444d0e77346838911', weight: 70},
      {agentId: 'agent_7c4e1b28f0a94d6591cc2fd340', weight: 30}
    ]
  })
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test', 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.teamfollowup.ai/api/agent-builder/agents/{id}/split-test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'revision' => 4,
    'variants' => [
        [
                'agentId' => 'agent_1ffdb9717444d0e77346838911',
                'weight' => 70
        ],
        [
                'agentId' => 'agent_7c4e1b28f0a94d6591cc2fd340',
                'weight' => 30
        ]
    ]
  ]),
  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.teamfollowup.ai/api/agent-builder/agents/{id}/split-test"

	payload := strings.NewReader("{\n  \"revision\": 4,\n  \"variants\": [\n    {\n      \"agentId\": \"agent_1ffdb9717444d0e77346838911\",\n      \"weight\": 70\n    },\n    {\n      \"agentId\": \"agent_7c4e1b28f0a94d6591cc2fd340\",\n      \"weight\": 30\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"revision\": 4,\n  \"variants\": [\n    {\n      \"agentId\": \"agent_1ffdb9717444d0e77346838911\",\n      \"weight\": 70\n    },\n    {\n      \"agentId\": \"agent_7c4e1b28f0a94d6591cc2fd340\",\n      \"weight\": 30\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/agents/{id}/split-test")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"revision\": 4,\n  \"variants\": [\n    {\n      \"agentId\": \"agent_1ffdb9717444d0e77346838911\",\n      \"weight\": 70\n    },\n    {\n      \"agentId\": \"agent_7c4e1b28f0a94d6591cc2fd340\",\n      \"weight\": 30\n    }\n  ]\n}"

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

{
  "success": true,
  "splitTest": {
    "locationId": "loc_9f7a123",
    "campaignId": "campaign_speed_to_lead_123",
    "primaryAgentId": "agent_1ffdb9717444d0e77346838911",
    "status": "active",
    "revision": 5,
    "sync": {
      "status": "healthy",
      "failedAt": null
    },
    "variants": [
      {
        "agentId": "agent_1ffdb9717444d0e77346838911",
        "name": "Speed to Lead",
        "sequence": 1,
        "weight": 70,
        "status": "active",
        "addedAt": "2026-08-14T09:12:44.318Z",
        "removedAt": null,
        "isPrimary": true
      },
      {
        "agentId": "agent_7c4e1b28f0a94d6591cc2fd340",
        "name": "Speed to Lead II",
        "sequence": 2,
        "weight": 30,
        "status": "active",
        "addedAt": "2026-08-20T16:04:02.771Z",
        "removedAt": null,
        "isPrimary": false
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

string

required

Agent id of the Primary Variant. Every split operation is addressed through the primary, not through a secondary variant.

Minimum string length: 1

Body

application/json

Replacement weights for every variant in the split.

Weights are replaced wholesale, not patched. Every variant in the split must appear exactly once, and the weights of the ones you keep live must total 100.

This is also how a variant is included in or excluded from the cycle. Send weight: 0 to exclude it; send any weight from 1 to include it again. Omitting a variant is an error rather than a shorthand for excluding it, so a caller that drops one by accident is refused instead of quietly taking an agent off the air.

revision

integer

required

The revision from the split you are changing.

Required range: x >= 1

Example:

4

variants

object[]

required

Minimum array length: 2

Show child attributes

{key}

any

Response

The split after re-weighting.

success

boolean

required

splitTest

object

required

Show child attributes

Agents

Split Testing

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Billing

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Update split weights

Authorizations

Path Parameters

Body

Response