Enroll existing leads

Preview or enroll contacts carrying the campaign’s GoHighLevel start tags.

It finds the GoHighLevel contacts that carry every one of this campaign’s start tags and none of its exclusion tags, and adds them to the campaign’s call queue. With dryRun true, the default, it only counts them and shows up to 25. With dryRun false, it adds up to limit contacts, and the campaign calls them on its schedule. Each added contact gets the cadence step tag in GoHighLevel. Contacts with no phone number, or already in the queue, are skipped. It runs only on a live campaign of a live GoHighLevel sub-account: speed to lead, power dialer or reactivation.

Required API key scope: campaigns:write.

POST

api

agent-builder

agents

{id}

campaign

enroll-existing-leads

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/enroll-existing-leads \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "dryRun": true,
  "limit": 1000
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/enroll-existing-leads"

payload = {
    "dryRun": True,
    "limit": 1000
}
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({dryRun: true, limit: 1000})
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/enroll-existing-leads', 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/enroll-existing-leads",
  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([
    'dryRun' => true,
    'limit' => 1000
  ]),
  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/enroll-existing-leads"

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

require 'uri'
require 'net/http'

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

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  \"dryRun\": true,\n  \"limit\": 1000\n}"

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

{
  "success": true,
  "data": {
    "dryRun": true,
    "locationId": "loc_abc123",
    "campaignId": "cmp_123",
    "includeTags": [
      "new_lead"
    ],
    "excludeTags": [
      "do_not_call"
    ],
    "matched": 1,
    "enrolled": 0,
    "statuses": {},
    "preview": []
  }
}

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

dryRun

boolean

default:true

True, the default, only counts the matching contacts and shows up to 25. False adds them to the call queue.

Example:

true

limit

integer

default:1000

The most tagged contacts to read from GoHighLevel, 1 to 5000. Default 1000. When it is reached, truncated comes back true.

Required range: 1 <= x <= 5000

Example:

1000

Response

Enrollment preview or result.

success

boolean

required

data

object

required

Show child attributes

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/enroll-existing-leads \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "dryRun": true,
  "limit": 1000
}'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/enroll-existing-leads"

payload = {
    "dryRun": True,
    "limit": 1000
}
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({dryRun: true, limit: 1000})
};

fetch('https://api.teamfollowup.ai/api/agent-builder/agents/{id}/campaign/enroll-existing-leads', 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/enroll-existing-leads",
  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([
    'dryRun' => true,
    'limit' => 1000
  ]),
  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/enroll-existing-leads"

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

require 'uri'
require 'net/http'

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

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  \"dryRun\": true,\n  \"limit\": 1000\n}"

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

{
  "success": true,
  "data": {
    "dryRun": true,
    "locationId": "loc_abc123",
    "campaignId": "cmp_123",
    "includeTags": [
      "new_lead"
    ],
    "excludeTags": [
      "do_not_call"
    ],
    "matched": 1,
    "enrolled": 0,
    "statuses": {},
    "preview": []
  }
}

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

Enroll existing leads

Authorizations

Path Parameters

Query Parameters

Body

Response