Remove a voice

DELETE

api

agent-builder

voices

library

{providerVoiceId}

cURL

curl --request DELETE \
  --url https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId} \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}', 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/voices/library/{providerVoiceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "voices": [],
  "used": 0,
  "limit": 5,
  "remaining": 5,
  "reassignedAgents": 2,
  "incompleteAgents": 0
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

providerVoiceId

string

required

The voice id as the speech provider knows it: the id used when the voice was added.

Minimum string length: 1

Response

Voice removed.

The library after the removal, plus what had to be moved off the voice.

success

boolean

required

voices

object[]

required

Show child attributes

used

integer

required

Required range: x >= 0

Example:

0

limit

integer | null

required

Required range: x >= 0

Example:

5

remaining

integer | null

required

Required range: x >= 0

Example:

5

reassignedAgents

integer

required

Agents that were speaking with this voice and have been moved to the default one. Reported so the caller can say so rather than leaving it to be discovered on the next call.

Required range: x >= 0

Example:

2

incompleteAgents

integer

required

Agents that could NOT be moved. The removal still succeeded; this is the only signal that one of them still needs attention, so treat a non-zero value as work to do rather than noise.

Required range: x >= 0

Example:

0

cURL

curl --request DELETE \
  --url https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId} \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}', 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/voices/library/{providerVoiceId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/agent-builder/voices/library/{providerVoiceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "voices": [],
  "used": 0,
  "limit": 5,
  "remaining": 5,
  "reassignedAgents": 2,
  "incompleteAgents": 0
}

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

Authorizations

Path Parameters

Response