Delete Audience
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/delete_audience \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"audienceId": "<string>",
"cancelAwaitingEnrollments": true,
"cancelInProgressEnrollments": true
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/delete_audience"
payload = {
"audienceId": "<string>",
"cancelAwaitingEnrollments": True,
"cancelInProgressEnrollments": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
audienceId: '<string>',
cancelAwaitingEnrollments: true,
cancelInProgressEnrollments: true
})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/delete_audience', 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://gateway.firsttouch.ai/api/public/tools/delete_audience",
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([
'audienceId' => '<string>',
'cancelAwaitingEnrollments' => true,
'cancelInProgressEnrollments' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://gateway.firsttouch.ai/api/public/tools/delete_audience"
payload := strings.NewReader("{\n \"audienceId\": \"<string>\",\n \"cancelAwaitingEnrollments\": true,\n \"cancelInProgressEnrollments\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://gateway.firsttouch.ai/api/public/tools/delete_audience")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audienceId\": \"<string>\",\n \"cancelAwaitingEnrollments\": true,\n \"cancelInProgressEnrollments\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/delete_audience")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"audienceId\": \"<string>\",\n \"cancelAwaitingEnrollments\": true,\n \"cancelInProgressEnrollments\": true\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Audiences
Delete Audience
Requires the admin team role or global admin access. Check get_current_user.toolAccess before calling.
Delete an existing audience.
Usage notes
- Before calling this tool, warn the user that deletion cannot be undone.
- Ask whether to cancel awaiting enrollments and whether to cancel enrollments already in progress if the user did not explicitly specify each choice.
- Both options default to true only after the user has been asked.
POST
/
api
/
public
/
tools
/
delete_audience
Delete Audience
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/delete_audience \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"audienceId": "<string>",
"cancelAwaitingEnrollments": true,
"cancelInProgressEnrollments": true
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/delete_audience"
payload = {
"audienceId": "<string>",
"cancelAwaitingEnrollments": True,
"cancelInProgressEnrollments": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
audienceId: '<string>',
cancelAwaitingEnrollments: true,
cancelInProgressEnrollments: true
})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/delete_audience', 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://gateway.firsttouch.ai/api/public/tools/delete_audience",
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([
'audienceId' => '<string>',
'cancelAwaitingEnrollments' => true,
'cancelInProgressEnrollments' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://gateway.firsttouch.ai/api/public/tools/delete_audience"
payload := strings.NewReader("{\n \"audienceId\": \"<string>\",\n \"cancelAwaitingEnrollments\": true,\n \"cancelInProgressEnrollments\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://gateway.firsttouch.ai/api/public/tools/delete_audience")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audienceId\": \"<string>\",\n \"cancelAwaitingEnrollments\": true,\n \"cancelInProgressEnrollments\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/delete_audience")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"audienceId\": \"<string>\",\n \"cancelAwaitingEnrollments\": true,\n \"cancelInProgressEnrollments\": true\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Body
application/json
Response
Tool result.