Skip to main content
POST
/
v1
/
prospects
/
events
/
enrollments
Add Prospects Enrollments
curl --request POST \
  --url https://api.explorium.ai/v1/prospects/events/enrollments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "enrollment_key": "<string>",
  "event_types": [
    "prospect_changed_role"
  ],
  "prospect_ids": [
    "<string>"
  ],
  "request_context": null
}
'
{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  },
  "enrollment_key": "<string>",
  "enrollment_id": "<string>"
}

​
Description

The Prospect Events Enrollment endpoint enables you to monitor specific prospects for professional changes and milestones. This “subscription” approach automates tracking of individual career movements such as job changes, role changes, and work anniversaries. When you enroll, the system will continuously monitor for new events related to your specified prospects. These events can be retrieved later or delivered via webhook, depending on your integration preferences.

​
Important Considerations for Enrollments

  • Multiple event types can be monitored for the same set of prospects.
  • Each enrollment is uniquely identified by its enrollment_key.
  • Events are collected in the background, optimizing API usage and ensuring you don’t miss important updates.
Input: Define parameters including prospect_ids, event_types, and ttl_days. Processing: The system registers your enrollment and begins monitoring for events. Output: A confirmation response containing your enrollment_id for future reference.
FieldTypeDescription
enrollment_keyStringA unique identifier for this enrollment
prospect_idsArrayList of Prospect IDs to monitor for events
event_typesArrayTypes of events to monitor (e.g., prospect_changed_role, prospect_changed_company)
Bash
curl -X POST \
  "https://api.explorium.ai/v1/prospects/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "enrollment_key": "tech_executives_monitor",
  "prospect_ids": [
    "20ae6cbf564ee683e66685e429844a5ff8ffc30f",
    "4c485f009d59e319dc039cdf3e935b85014e6a33"
  ],
  "event_types": [
    "prospect_changed_role",
    "prospect_changed_company"
  ],
  "ttl_days": 365
}'
JSON
{
  "request_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollment_key": "tech_executives_monitor",
  "enrollment_id": "en_8d52c3f1"
}
  • Use descriptive enrollment_key values to easily identify different monitoring setups.
  • Group prospects by industry, seniority, or target accounts for organized monitoring.
  • Combine with webhook registration for real-time notifications of career changes.
For detailed endpoint explanations, request examples, and integration tips, explore the documentation sections above.

Authorizations

​
api_key
string
header
required

Body

application/json
​
enrollment_key
string
required
Minimum string length: 4
​
event_types
enum<string>[]
required
Minimum array length: 1

The ProspectsEventIdentifier class is an enumeration that defines event identifiers related to prospects.

This enum is used to categorize and track events associated with prospects, such as:

  • Role changes (e.g., when a prospect changes their role within a company)
  • Company changes (e.g., when a prospect moves to a new company)
  • Job anniversaries (e.g., celebrating the anniversary of a prospect's job start date)

These identifiers ensure consistent handling and classification of prospect-related events across the application.

Available options:
prospect_changed_role,
prospect_changed_company,
prospect_job_start_anniversary
​
prospect_ids
string[]
required
Required array length: 1 - 20 elements
​
request_context
Request Context · object
Example:

null

Response

Successful Response

This is base response model for all responses in partner service.

​
response_context
ResponseContext · object
required
​
enrollment_key
string
required
Minimum string length: 4
​
enrollment_id
string
required