Delete Prospects Enrollments
curl --request DELETE \
--url https://api.explorium.ai/v1/prospects/events/enrollments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"enrollment_id": "<string>",
"request_context": null
}
'import requests
url = "https://api.explorium.ai/v1/prospects/events/enrollments"
payload = {
"enrollment_id": "<string>",
"request_context": None
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({enrollment_id: '<string>', request_context: null})
};
fetch('https://api.explorium.ai/v1/prospects/events/enrollments', 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.explorium.ai/v1/prospects/events/enrollments",
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([
'enrollment_id' => '<string>',
'request_context' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.explorium.ai/v1/prospects/events/enrollments"
payload := strings.NewReader("{\n \"enrollment_id\": \"<string>\",\n \"request_context\": null\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("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.delete("https://api.explorium.ai/v1/prospects/events/enrollments")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrollment_id\": \"<string>\",\n \"request_context\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.explorium.ai/v1/prospects/events/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrollment_id\": \"<string>\",\n \"request_context\": null\n}"
response = http.request(request)
puts response.read_body{
"response_context": {
"correlation_id": "<string>",
"request_status": "success",
"time_took_in_seconds": 123
},
"status": "success"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Prospects Events
Delete Prospects Enrollments
Delete events enrollments records
DELETE
/
v1
/
prospects
/
events
/
enrollments
Delete Prospects Enrollments
curl --request DELETE \
--url https://api.explorium.ai/v1/prospects/events/enrollments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"enrollment_id": "<string>",
"request_context": null
}
'import requests
url = "https://api.explorium.ai/v1/prospects/events/enrollments"
payload = {
"enrollment_id": "<string>",
"request_context": None
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({enrollment_id: '<string>', request_context: null})
};
fetch('https://api.explorium.ai/v1/prospects/events/enrollments', 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.explorium.ai/v1/prospects/events/enrollments",
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([
'enrollment_id' => '<string>',
'request_context' => null
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.explorium.ai/v1/prospects/events/enrollments"
payload := strings.NewReader("{\n \"enrollment_id\": \"<string>\",\n \"request_context\": null\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("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.delete("https://api.explorium.ai/v1/prospects/events/enrollments")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrollment_id\": \"<string>\",\n \"request_context\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.explorium.ai/v1/prospects/events/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrollment_id\": \"<string>\",\n \"request_context\": null\n}"
response = http.request(request)
puts response.read_body{
"response_context": {
"correlation_id": "<string>",
"request_status": "success",
"time_took_in_seconds": 123
},
"status": "success"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Description
The Delete Prospect Events Enrollment endpoint allows you to cancel an active prospect monitoring configuration. This is useful when you no longer need to track certain individuals or when a monitoring strategy needs to be reconfigured.How It Works
How It Works
Input: Specify the enrollment_id you wish to cancel.
Processing: The system removes the enrollment configuration.
Output: A confirmation of successful deletion.
Processing: The system removes the enrollment configuration.
Output: A confirmation of successful deletion.
Query Parameters
Query Parameters
| Field | Type | Description |
|---|---|---|
| enrollment_id | String | The unique identifier of the enrollment to delete |
Example Request (cURL)
Example Request (cURL)
Bash
curl -X DELETE \
"https://api.explorium.ai/v1/prospects/events/enrollments" \
-H "API_KEY: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"enrollment_id": "en_8d52c3f1"
}'
Example Response
Example Response
JSON
{
"status": "success"
}
Authorizations
APIKeyHeaderAPIKeyHeader
Body
application/json
Response
Successful Response
This is base response model for all responses in partner service.
Show child attributes
Show child attributes
The RequestStatus class is an enumeration that defines the possible statuses of a request.
This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application.
Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure.
Available options:
success, miss, failure Was this page helpful?