Stop calling several native contacts

Puts up to 100 contacts on do-not-call at once, each the way POST /api/native-contacts/{contactId}/do-not-call does for one. Calls already queued for them are stopped.

It only ever stops. There is no bulk resume, and nothing in the body makes one. To call a contact again, clear it for that one contact.

The decision is recorded as made by your team, not as a request from the contact.

A contact that cannot be stopped, such as one deleted since, is named in failed, and the rest are still stopped. Re-marking a contact who is already stopped is not a failure.

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

Required API key scope: contacts:write.

POST

api

native-contacts

bulk-do-not-call

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/native-contacts/bulk-do-not-call \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactIds": [
    "nct_0123456789abcdef0123",
    "nct_9f1c77b3a0de4412bb70"
  ],
  "reason": "Wrong list."
}'

import requests

url = "https://api.teamfollowup.ai/api/native-contacts/bulk-do-not-call"

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

fetch('https://api.teamfollowup.ai/api/native-contacts/bulk-do-not-call', 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/bulk-do-not-call",
  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([
    '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/bulk-do-not-call"

	payload := strings.NewReader("{\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/bulk-do-not-call")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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/bulk-do-not-call")

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

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

{
  "success": true,
  "data": {
    "stopped": 1,
    "failed": [
      {
        "contactId": "nct_9f1c77b3a0de4412bb70",
        "error": "Contact not found."
      }
    ]
  }
}

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 contacts to stop calling, and why.

contactIds

string[]

required

The contacts to stop calling. Up to 100 per request.

Required array length: 1 - 100 elements

reason

string

Kept with the decision on every contact named.

Maximum string length: 500

{key}

any

Response

How many stopped, and which ones could not.

success

boolean

required

data

object

required

Show child attributes

{key}

any

cURL

curl --request POST \
  --url https://api.teamfollowup.ai/api/native-contacts/bulk-do-not-call \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactIds": [
    "nct_0123456789abcdef0123",
    "nct_9f1c77b3a0de4412bb70"
  ],
  "reason": "Wrong list."
}'

import requests

url = "https://api.teamfollowup.ai/api/native-contacts/bulk-do-not-call"

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

fetch('https://api.teamfollowup.ai/api/native-contacts/bulk-do-not-call', 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/bulk-do-not-call",
  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([
    '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/bulk-do-not-call"

	payload := strings.NewReader("{\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/bulk-do-not-call")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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/bulk-do-not-call")

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

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

{
  "success": true,
  "data": {
    "stopped": 1,
    "failed": [
      {
        "contactId": "nct_9f1c77b3a0de4412bb70",
        "error": "Contact not found."
      }
    ]
  }
}

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

Stop calling several native contacts

Authorizations

Query Parameters

Body

Response