Skip to main content
PATCH
/
v1
/
prospects
/
events
/
enrollments
Update Prospects Enrollments
curl --request PATCH \
  --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"
  ],
  "enrollment_id": "<string>",
  "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

Update an existing prospect’s enrollment.
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.
FieldTypeDescription
enrollment_keyStringA unique identifier for this enrollment
enrollment_idStringA 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",
  "enrollment_id": "en_8d52c3f1",
  "prospect_ids": [
    "20ae6cbf564ee683e66685e429844a5ff8ffc30f",
    "4c485f009d59e319dc039cdf3e935b85014e6a33"
  ],
  "event_types": [
    "prospect_changed_role",
    "prospect_changed_company"
  ]
}'
Bash
{
  "request_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollment_key": "tech_executives_monitor",
  "enrollment_id": "en_8d52c3f1"
}

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
​
enrollment_id
string
required
​
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