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

Description

Update an existing prospect's enrollment.

How It Works

Input: Define parameters including enrollment_key and enrollment_id to update, and updated prospect_ids, and event_types.
Processing: The system will update your your enrollment and update the monitoring for events.
Output: A confirmation response containing your enrollment_key and enrollment_id for future reference.

Query Parameters

Field	Type	Description
enrollment_key	String	A unique identifier for this enrollment
enrollment_id	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",
  "enrollment_id": "en_8d52c3f1",
  "prospect_ids": [
    "20ae6cbf564ee683e66685e429844a5ff8ffc30f",
    "4c485f009d59e319dc039cdf3e935b85014e6a33"
  ],
  "event_types": [
    "prospect_changed_role",
    "prospect_changed_company"
  ]
}'

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