Add Prospects Enrollments

Endpoint: `POST /v1/prospects/events/enrollments`

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.

How It Works

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.

Query Parameters

Field	Type	Description
enrollment_key	String	A unique identifier for this enrollment
prospect_ids	Array	List of Prospect IDs to monitor for events
event_types	Array	Types of events to monitor (e.g., prospect_changed_role, prospect_changed_company)

Example Request (cURL)

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
}'

Example Response

{
  "request_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollment_key": "tech_executives_monitor",
  "enrollment_id": "en_8d52c3f1"
}

Best Practices

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.

Endpoint: POST /v1/prospects/events/enrollments

Description

Important Considerations for Enrollments

Endpoint: `POST /v1/prospects/events/enrollments`