Link a project to this master agent

Link one project as a child of this master agent.

Creates a child campaign on the target project, copies the parent script, settings and post-call workflow to it, then scans the target project for the assets the shared slots need and binds each one that matches exactly one asset by name. Anything ambiguous or missing is left unbound and is reported in the returned campaign’s masterBindingScanStatus and counts. A parent campaign that is not a master yet is made one first. Linking the same project again reuses its child campaign and syncs it again.

Required API key scope: campaigns:write.

POST

api

agent-builder

agents

{id}

campaign

master

projects

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/master/projects \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetLocationId": "loc_child_456"
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/master/projects"

payload = { "targetLocationId": "loc_child_456" }
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({targetLocationId: 'loc_child_456'})
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/master/projects', 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}/campaign/master/projects",
  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([
    'targetLocationId' => 'loc_child_456'
  ]),
  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}/campaign/master/projects"

	payload := strings.NewReader("{\n  \"targetLocationId\": \"loc_child_456\"\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/agent-builder/agents/{id}/campaign/master/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"targetLocationId\": \"loc_child_456\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"targetLocationId\": \"loc_child_456\"\n}"

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

{
  "success": true,
  "campaign": {
    "id": "campaign_child_789",
    "name": "Speed to Lead",
    "masterRole": "child",
    "masterCampaignId": "campaign_speed_to_lead_123",
    "masterSyncStatus": "synced",
    "masterBindingScanStatus": "ready",
    "masterBindingScanMatchedCount": 3,
    "masterBindingScanMissingCount": 0,
    "masterBindingScanError": null
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

string

required

Agent id.

Minimum string length: 1

Query Parameters

locationId

string

Pair with campaignId; omit both for primary campaign.

Minimum string length: 1

campaignId

string

Pair with locationId; omit both for primary campaign.

Minimum string length: 1

Body

application/json

targetLocationId

string

required

The location id of the sub-account to add to this master agent. You need write access to it.

Example:

"loc_child_456"

{key}

any

Response

Child campaign created on the target project.

success

boolean

required

campaign

object

required

The child campaign as stored on the target project, including its master sync and binding-scan fields.

Show child attributes

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/master/projects \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetLocationId": "loc_child_456"
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/master/projects"

payload = { "targetLocationId": "loc_child_456" }
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({targetLocationId: 'loc_child_456'})
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/master/projects', 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}/campaign/master/projects",
  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([
    'targetLocationId' => 'loc_child_456'
  ]),
  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}/campaign/master/projects"

	payload := strings.NewReader("{\n  \"targetLocationId\": \"loc_child_456\"\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/agent-builder/agents/{id}/campaign/master/projects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"targetLocationId\": \"loc_child_456\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"targetLocationId\": \"loc_child_456\"\n}"

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

{
  "success": true,
  "campaign": {
    "id": "campaign_child_789",
    "name": "Speed to Lead",
    "masterRole": "child",
    "masterCampaignId": "campaign_speed_to_lead_123",
    "masterSyncStatus": "synced",
    "masterBindingScanStatus": "ready",
    "masterBindingScanMatchedCount": 3,
    "masterBindingScanMissingCount": 0,
    "masterBindingScanError": null
  }
}

Developer setup

Agents

TFU Live

In-call Capabilities

Campaigns

Master agent

Phone Numbers

Caller ID

Voices

Projects

Calls

Contacts

Native Contacts

Native Calendar

Analytics

Billing

Link a project to this master agent

Authorizations

Path Parameters

Query Parameters

Body

Response