Put contacts into a campaign

Starts a campaign for contacts you already have, such as a list that came in before the campaign existed.

Accepted contacts are queued, and the rest are counted by why they were not. A contact on do-not-call is always skipped, and no argument overrides that.

The reply comes before the work ends, so contacts enter the campaign shortly after it.

Only on a sub-account with no CRM. A sub-account with a CRM starts campaigns from its CRM, and is refused with 400.

A campaign whose TFU Live agent only answers calls is refused with 409 CampaignOnlyAnswersCalls. Turn on outbound for the agent first.

Cookie-auth callers must send the x-csrf-token header.

Required API key scope: contacts:write.

POST

api

native-contacts

enroll

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/native-contacts/enroll \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaignId": "cmp_7f0a1c",
  "contactIds": [
    "nct_0123456789abcdef0123",
    "nct_9f1c77b3a0de4412bb70"
  ]
}'

import requests

url = "https://api.teamfollowup.ai/api/native-contacts/enroll"

payload = {
    "campaignId": "cmp_7f0a1c",
    "contactIds": ["nct_0123456789abcdef0123", "nct_9f1c77b3a0de4412bb70"]
}
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_7f0a1c',
    contactIds: ['nct_0123456789abcdef0123', 'nct_9f1c77b3a0de4412bb70']
  })
};

fetch('https://api.teamfollowup.ai/api/native-contacts/enroll', 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/native-contacts/enroll",
  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_7f0a1c',
    'contactIds' => [
        'nct_0123456789abcdef0123',
        'nct_9f1c77b3a0de4412bb70'
    ]
  ]),
  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/native-contacts/enroll"

	payload := strings.NewReader("{\n  \"campaignId\": \"cmp_7f0a1c\",\n  \"contactIds\": [\n    \"nct_0123456789abcdef0123\",\n    \"nct_9f1c77b3a0de4412bb70\"\n  ]\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/native-contacts/enroll")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaignId\": \"cmp_7f0a1c\",\n  \"contactIds\": [\n    \"nct_0123456789abcdef0123\",\n    \"nct_9f1c77b3a0de4412bb70\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/native-contacts/enroll")

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_7f0a1c\",\n  \"contactIds\": [\n    \"nct_0123456789abcdef0123\",\n    \"nct_9f1c77b3a0de4412bb70\"\n  ]\n}"

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

{
  "success": true,
  "data": {
    "accepted": 1,
    "skipped": {
      "doNotCall": 1,
      "noPhone": 0,
      "notFound": 0
    },
    "campaignName": "New lead follow up"
  }
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId

string

required

The sub-account these contacts belong to. Your access to it is checked on every call. A sub-account with a CRM answers 400.

Body

application/json

The campaign, and who to put in it.

campaignId

string

required

The id of the campaign to start. It must be on this sub-account.

Example:

"cmp_7f0a1c"

contactIds

string[]

required

The contacts to put in the campaign, up to 1,000. A contact on do-not-call, with no phone, or not found is skipped.

{key}

any

Response

Accepted, with what was skipped and why.

success

boolean

required

data

object

required

Show child attributes

{key}

any

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/native-contacts/enroll \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaignId": "cmp_7f0a1c",
  "contactIds": [
    "nct_0123456789abcdef0123",
    "nct_9f1c77b3a0de4412bb70"
  ]
}'

import requests

url = "https://api.teamfollowup.ai/api/native-contacts/enroll"

payload = {
    "campaignId": "cmp_7f0a1c",
    "contactIds": ["nct_0123456789abcdef0123", "nct_9f1c77b3a0de4412bb70"]
}
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_7f0a1c',
    contactIds: ['nct_0123456789abcdef0123', 'nct_9f1c77b3a0de4412bb70']
  })
};

fetch('https://api.teamfollowup.ai/api/native-contacts/enroll', 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/native-contacts/enroll",
  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_7f0a1c',
    'contactIds' => [
        'nct_0123456789abcdef0123',
        'nct_9f1c77b3a0de4412bb70'
    ]
  ]),
  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/native-contacts/enroll"

	payload := strings.NewReader("{\n  \"campaignId\": \"cmp_7f0a1c\",\n  \"contactIds\": [\n    \"nct_0123456789abcdef0123\",\n    \"nct_9f1c77b3a0de4412bb70\"\n  ]\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/native-contacts/enroll")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"campaignId\": \"cmp_7f0a1c\",\n  \"contactIds\": [\n    \"nct_0123456789abcdef0123\",\n    \"nct_9f1c77b3a0de4412bb70\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/native-contacts/enroll")

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_7f0a1c\",\n  \"contactIds\": [\n    \"nct_0123456789abcdef0123\",\n    \"nct_9f1c77b3a0de4412bb70\"\n  ]\n}"

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

{
  "success": true,
  "data": {
    "accepted": 1,
    "skipped": {
      "doNotCall": 1,
      "noPhone": 0,
      "notFound": 0
    },
    "campaignName": "New lead follow up"
  }
}

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

Put contacts into a campaign

Authorizations

Query Parameters

Body

Response