Delete list entries in bulk
curl --request POST \
--url https://{instance}/api/public/lists/v1/deleteEntries \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"listName": "<string>",
"entries": [
"<string>"
],
"tenantUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://{instance}/api/public/lists/v1/deleteEntries"
payload = {
"listName": "<string>",
"entries": ["<string>"],
"tenantUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
listName: '<string>',
entries: ['<string>'],
tenantUid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://{instance}/api/public/lists/v1/deleteEntries', 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://{instance}/api/public/lists/v1/deleteEntries",
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([
'listName' => '<string>',
'entries' => [
'<string>'
],
'tenantUid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{instance}/api/public/lists/v1/deleteEntries"
payload := strings.NewReader("{\n \"listName\": \"<string>\",\n \"entries\": [\n \"<string>\"\n ],\n \"tenantUid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://{instance}/api/public/lists/v1/deleteEntries")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listName\": \"<string>\",\n \"entries\": [\n \"<string>\"\n ],\n \"tenantUid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/public/lists/v1/deleteEntries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listName\": \"<string>\",\n \"entries\": [\n \"<string>\"\n ],\n \"tenantUid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"modifiedEntries": 1
}List API
Delete list entries in bulk
Deletes entries from one tenant-scoped or deployment-global list. Requests can contain at most 500 entries. Missing entries are ignored and not counted as modifications.
POST
/
public
/
lists
/
v1
/
deleteEntries
Delete list entries in bulk
curl --request POST \
--url https://{instance}/api/public/lists/v1/deleteEntries \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"listName": "<string>",
"entries": [
"<string>"
],
"tenantUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://{instance}/api/public/lists/v1/deleteEntries"
payload = {
"listName": "<string>",
"entries": ["<string>"],
"tenantUid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
listName: '<string>',
entries: ['<string>'],
tenantUid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://{instance}/api/public/lists/v1/deleteEntries', 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://{instance}/api/public/lists/v1/deleteEntries",
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([
'listName' => '<string>',
'entries' => [
'<string>'
],
'tenantUid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://{instance}/api/public/lists/v1/deleteEntries"
payload := strings.NewReader("{\n \"listName\": \"<string>\",\n \"entries\": [\n \"<string>\"\n ],\n \"tenantUid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://{instance}/api/public/lists/v1/deleteEntries")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"listName\": \"<string>\",\n \"entries\": [\n \"<string>\"\n ],\n \"tenantUid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/public/lists/v1/deleteEntries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"listName\": \"<string>\",\n \"entries\": [\n \"<string>\"\n ],\n \"tenantUid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"modifiedEntries": 1
}Authorizations
Use format apikey <token>.
Body
application/json
Response
Number of entries effectively deleted.
Required range:
x >= 0⌘I