cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaignId": "cmp_123",
  "scope": "campaign"
}'

import requests

url = "https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links"

payload = {
    "campaignId": "cmp_123",
    "scope": "campaign"
}
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({campaignId: 'cmp_123', scope: 'campaign'})
};

fetch('https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links', 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/tfu-live-agents/{id}/test-share-links",
  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([
    'campaignId' => 'cmp_123',
    'scope' => 'campaign'
  ]),
  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/tfu-live-agents/{id}/test-share-links"

	payload := strings.NewReader("{\n  \"campaignId\": \"cmp_123\",\n  \"scope\": \"campaign\"\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.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaignId\": \"cmp_123\",\n  \"scope\": \"campaign\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links")

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  \"campaignId\": \"cmp_123\",\n  \"scope\": \"campaign\"\n}"

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

{
  "success": true,
  "data": {
    "scope": "campaign",
    "reused": true,
    "expiresAt": "2026-11-02T00:00:00.000Z",
    "links": {
      "phone": "https://app.teamfollowup.ai/test/share/cmp_123?scope=campaign&channel=phone#grant=example",
      "web": "https://app.teamfollowup.ai/test/share/cmp_123?scope=campaign&channel=web#grant=example"
    },
    "web": {
      "available": false,
      "blockers": [
        {
          "code": "WEB_CAMPAIGN_PHONE_ONLY"
        }
      ]
    }
  }
}

Issue TFU Live test links

Issue or reuse secure client test links for this profile and its owned TFU Live campaign. Does not start a call or change agent/campaign configuration. Agent scope simulates effects and supports phone or browser; campaign scope runs the real campaign by phone only. Links expire 30 days after issuance. Treat the returned grant fragments as secrets; share only with intended testers. Default issuance reuses valid links. rotate:true invalidates previous links and sessions.

Required scope: agents:write.

Required API key scope: agents:write.

POST

api

tfu-live-agents

{id}

test-share-links

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaignId": "cmp_123",
  "scope": "campaign"
}'

import requests

url = "https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links"

payload = {
    "campaignId": "cmp_123",
    "scope": "campaign"
}
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({campaignId: 'cmp_123', scope: 'campaign'})
};

fetch('https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links', 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/tfu-live-agents/{id}/test-share-links",
  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([
    'campaignId' => 'cmp_123',
    'scope' => 'campaign'
  ]),
  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/tfu-live-agents/{id}/test-share-links"

	payload := strings.NewReader("{\n  \"campaignId\": \"cmp_123\",\n  \"scope\": \"campaign\"\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.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaignId\": \"cmp_123\",\n  \"scope\": \"campaign\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/tfu-live-agents/{id}/test-share-links")

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  \"campaignId\": \"cmp_123\",\n  \"scope\": \"campaign\"\n}"

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

{
  "success": true,
  "data": {
    "scope": "campaign",
    "reused": true,
    "expiresAt": "2026-11-02T00:00:00.000Z",
    "links": {
      "phone": "https://app.teamfollowup.ai/test/share/cmp_123?scope=campaign&channel=phone#grant=example",
      "web": "https://app.teamfollowup.ai/test/share/cmp_123?scope=campaign&channel=web#grant=example"
    },
    "web": {
      "available": false,
      "blockers": [
        {
          "code": "WEB_CAMPAIGN_PHONE_ONLY"
        }
      ]
    }
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

string

required

TFU Live agent id. Never use an ordinary provider agent id.

Query Parameters

locationId

string

required

Sub-account belonging to the authenticated agency and any narrower credential location binding.

Body

application/json

The bound campaign and test scope. Rotation is optional and explicit.

campaignId

string

required

Pattern: ^[A-Za-z0-9_-]{1,100}$

scope

enum<string>

required

Available options:

agent,

campaign

rotate

boolean

default:false

Explicitly invalidate the previous links and their sessions. Otherwise reuse a valid grant.

Response

Successful TFU Live response. Setup acceptance is not verified readiness or campaign activation.

success

any

required

data

object

required

Show child attributes

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Issue TFU Live test links

Authorizations

Path Parameters

Query Parameters

Body

Response