Create Prospect Enrollment
curl --request POST \
--url https://api.explorium.ai/v2/prospects/events/enrollments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"enrollment_key": "<string>",
"webhook_id": "<string>",
"event_types": [],
"prospect_ids": [
"<string>"
],
"request_context": null
}
'import requests
url = "https://api.explorium.ai/v2/prospects/events/enrollments"
payload = {
"enrollment_key": "<string>",
"webhook_id": "<string>",
"event_types": [],
"prospect_ids": ["<string>"],
"request_context": None
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enrollment_key: '<string>',
webhook_id: '<string>',
event_types: [],
prospect_ids: ['<string>'],
request_context: null
})
};
fetch('https://api.explorium.ai/v2/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/v2/prospects/events/enrollments",
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([
'enrollment_key' => '<string>',
'webhook_id' => '<string>',
'event_types' => [
],
'prospect_ids' => [
'<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/v2/prospects/events/enrollments"
payload := strings.NewReader("{\n \"enrollment_key\": \"<string>\",\n \"webhook_id\": \"<string>\",\n \"event_types\": [],\n \"prospect_ids\": [\n \"<string>\"\n ],\n \"request_context\": null\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.explorium.ai/v2/prospects/events/enrollments")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrollment_key\": \"<string>\",\n \"webhook_id\": \"<string>\",\n \"event_types\": [],\n \"prospect_ids\": [\n \"<string>\"\n ],\n \"request_context\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.explorium.ai/v2/prospects/events/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrollment_key\": \"<string>\",\n \"webhook_id\": \"<string>\",\n \"event_types\": [],\n \"prospect_ids\": [\n \"<string>\"\n ],\n \"request_context\": null\n}"
response = http.request(request)
puts response.read_body{
"enrollment_key": "<string>",
"enrollment_id": "<string>",
"webhook_id": "<string>",
"status": "active",
"response_context": {
"correlation_id": "<string>",
"request_status": "success",
"time_taken_in_seconds": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Prospects
Create prospect enrollment
POST
/
v2
/
prospects
/
events
/
enrollments
Create Prospect Enrollment
curl --request POST \
--url https://api.explorium.ai/v2/prospects/events/enrollments \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"enrollment_key": "<string>",
"webhook_id": "<string>",
"event_types": [],
"prospect_ids": [
"<string>"
],
"request_context": null
}
'import requests
url = "https://api.explorium.ai/v2/prospects/events/enrollments"
payload = {
"enrollment_key": "<string>",
"webhook_id": "<string>",
"event_types": [],
"prospect_ids": ["<string>"],
"request_context": None
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enrollment_key: '<string>',
webhook_id: '<string>',
event_types: [],
prospect_ids: ['<string>'],
request_context: null
})
};
fetch('https://api.explorium.ai/v2/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/v2/prospects/events/enrollments",
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([
'enrollment_key' => '<string>',
'webhook_id' => '<string>',
'event_types' => [
],
'prospect_ids' => [
'<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/v2/prospects/events/enrollments"
payload := strings.NewReader("{\n \"enrollment_key\": \"<string>\",\n \"webhook_id\": \"<string>\",\n \"event_types\": [],\n \"prospect_ids\": [\n \"<string>\"\n ],\n \"request_context\": null\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.explorium.ai/v2/prospects/events/enrollments")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enrollment_key\": \"<string>\",\n \"webhook_id\": \"<string>\",\n \"event_types\": [],\n \"prospect_ids\": [\n \"<string>\"\n ],\n \"request_context\": null\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.explorium.ai/v2/prospects/events/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enrollment_key\": \"<string>\",\n \"webhook_id\": \"<string>\",\n \"event_types\": [],\n \"prospect_ids\": [\n \"<string>\"\n ],\n \"request_context\": null\n}"
response = http.request(request)
puts response.read_body{
"enrollment_key": "<string>",
"enrollment_id": "<string>",
"webhook_id": "<string>",
"status": "active",
"response_context": {
"correlation_id": "<string>",
"request_status": "success",
"time_taken_in_seconds": 123
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Requires a
webhook_id of an active v2 webhook in your scope — unknown IDs return 404, a missing webhook_id or wrong scope/status returns 422; delivery is never silently re-pointed. Up to 1,000 IDs per request, unlimited total across requests.Authorizations
APIKeyHeaderAPIKeyHeader
Body
application/json
Minimum string length:
4Required array length:
1 - 1000 elementsAn enumeration.
Available options:
award, closing_office, company_award, cost_cutting, decrease_in_all_departments, decrease_in_customer_service_department, decrease_in_engineering_department, decrease_in_marketing_department, decrease_in_operations_department, decrease_in_sales_department, executive_joined_company, funding_round, hiring_in_creative_department, hiring_in_education_department, hiring_in_engineering_department, hiring_in_finance_department, hiring_in_health_department, hiring_in_human_resources_department, hiring_in_legal_department, hiring_in_marketing_department, hiring_in_operations_department, hiring_in_professional_service_department, hiring_in_sales_department, hiring_in_support_department, hiring_in_trade_department, hiring_in_unknown_department, increase_in_all_departments, increase_in_customer_service_department, increase_in_engineering_department, increase_in_marketing_department, increase_in_operations_department, increase_in_sales_department, ipo_announcement, lawsuits_and_legal_issues, merger_and_acquisitions, new_funding_round, new_investment, new_office, new_partnership, new_product, outages_and_security_breaches, prospect_changed_company, prospect_changed_role, prospect_job_start_anniversary Required array length:
1 - 1000 elementsPattern:
^[a-f0-9]{40}$Response
Successful Response
This is base response model for all responses in partner service.
Was this page helpful?