Batch Delete Location Resources
curl --request DELETE \
--url https://api.embedreach.com/api/resources/locations/batch \
--header 'Content-Type: application/json' \
--data '
{
"externalIds": [],
"cascade": false,
"deleteAll": false,
"dryRun": false
}
'import requests
url = "https://api.embedreach.com/api/resources/locations/batch"
payload = {
"externalIds": [],
"cascade": False,
"deleteAll": False,
"dryRun": False
}
headers = {"Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({externalIds: [], cascade: false, deleteAll: false, dryRun: false})
};
fetch('https://api.embedreach.com/api/resources/locations/batch', 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.embedreach.com/api/resources/locations/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'externalIds' => [
],
'cascade' => false,
'deleteAll' => false,
'dryRun' => false
]),
CURLOPT_HTTPHEADER => [
"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.embedreach.com/api/resources/locations/batch"
payload := strings.NewReader("{\n \"externalIds\": [],\n \"cascade\": false,\n \"deleteAll\": false,\n \"dryRun\": false\n}")
req, _ := http.NewRequest("DELETE", url, payload)
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.delete("https://api.embedreach.com/api/resources/locations/batch")
.header("Content-Type", "application/json")
.body("{\n \"externalIds\": [],\n \"cascade\": false,\n \"deleteAll\": false,\n \"dryRun\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/api/resources/locations/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalIds\": [],\n \"cascade\": false,\n \"deleteAll\": false,\n \"dryRun\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"batchId": "<string>",
"message": "<string>",
"recordCount": 123,
"schemaDefinitionId": "<string>"
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": {
"error": "<string>"
}
}Default Partner Resources
Batch Delete Location Resources
Deletes location resources via the event processor for asynchronous processing. Set cascade to true to also delete referencing resources in other schemas. Set deleteAll to true to delete all locations — without cascade, locations referenced by other schemas are left in place; with cascade, referencing resources are also deleted.
DELETE
/
api
/
resources
/
locations
/
batch
Batch Delete Location Resources
curl --request DELETE \
--url https://api.embedreach.com/api/resources/locations/batch \
--header 'Content-Type: application/json' \
--data '
{
"externalIds": [],
"cascade": false,
"deleteAll": false,
"dryRun": false
}
'import requests
url = "https://api.embedreach.com/api/resources/locations/batch"
payload = {
"externalIds": [],
"cascade": False,
"deleteAll": False,
"dryRun": False
}
headers = {"Content-Type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({externalIds: [], cascade: false, deleteAll: false, dryRun: false})
};
fetch('https://api.embedreach.com/api/resources/locations/batch', 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.embedreach.com/api/resources/locations/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'externalIds' => [
],
'cascade' => false,
'deleteAll' => false,
'dryRun' => false
]),
CURLOPT_HTTPHEADER => [
"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.embedreach.com/api/resources/locations/batch"
payload := strings.NewReader("{\n \"externalIds\": [],\n \"cascade\": false,\n \"deleteAll\": false,\n \"dryRun\": false\n}")
req, _ := http.NewRequest("DELETE", url, payload)
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.delete("https://api.embedreach.com/api/resources/locations/batch")
.header("Content-Type", "application/json")
.body("{\n \"externalIds\": [],\n \"cascade\": false,\n \"deleteAll\": false,\n \"dryRun\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/api/resources/locations/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalIds\": [],\n \"cascade\": false,\n \"deleteAll\": false,\n \"dryRun\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"batchId": "<string>",
"message": "<string>",
"recordCount": 123,
"schemaDefinitionId": "<string>"
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": {
"error": "<string>"
}
}Headers
If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.
Body
application/json
Array of external IDs to delete. Required (non-empty) unless deleteAll is true.
When true, also deletes resources in other schemas that reference the deleted resources.
Must be true to delete ALL resources for the schema. Without cascade, any resource that is referenced by a resource in another schema is left in place (neither it nor the referencing resource is deleted). With cascade, referencing resources in other schemas are also deleted. externalIds must be empty or omitted when deleteAll is true.
When true, returns a synchronous preview of what would be deleted without queueing the job or touching any data. Per-schema deletion counts and the number of resources that would be skipped due to references are included.