Skip to main content
POST
/
v1
/
businesses
/
events
/
enrollments
Add Businesses Enrollments
curl --request POST \
  --url https://api.explorium.ai/v1/businesses/events/enrollments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "enrollment_key": "<string>",
  "event_types": [
    "ipo_announcement"
  ],
  "business_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 Business Events Enrollment endpoint allows you to monitor specific businesses for future events. Rather than making repeated manual queries, enrollments let you “subscribe” to events for selected business IDs. This enables automated tracking of company activities such as funding rounds, IPOs, product launches, and more.
When you enroll, the system will continuously monitor for new events matching your criteria. 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 businesses.
  • Each enrollment is uniquely identified by its enrollment_key and enrollment_id.
  • Events are collected in the background, optimizing API usage and ensuring you don’t miss important updates.
  • Input: Define parameters including business_ids, and event_types.
  • 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
business_idsArrayList of Business IDs to monitor for events
event_typesArrayTypes of events to monitor (e.g., ipo_announcement, new_funding_round)
Bash
curl -X POST \
  "https://api.explorium.ai/v1/businesses/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "enrollment_key": "my_b2b_saas_monitor",
  "business_ids": [
    "8adce3ca1cef0c986b22310e369a0793",
    "665595bbb4e724de6f8bc705a5b84753"
  ],
  "event_types": [
    "ipo_announcement",
    "new_funding_round",
    "new_product"
  ]
}'
JSON
{
  "request_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollment_key": "my_b2b_saas_monitor",
  "enrollment_id": "en_7b429a01"
}
  • Use descriptive enrollment_key values to easily identify different monitoring setups.
  • Monitor only the most relevant event types to optimize performance.
  • Combine with webhook registration for real-time notifications.

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

Enumeration of business-related event identifiers.

This enum defines various types of events associated with businesses, such as:

  • Financial activities (e.g., IPO announcements, new funding rounds, new investments)
  • Organizational changes (e.g., new offices, closing offices, mergers and acquisitions)
  • Workforce trends (e.g., hiring in specific departments, increases or decreases in department sizes)
  • Product and partnership updates (e.g., new products, new partnerships)
  • Other significant events (e.g., company awards, outages, cost-cutting measures, legal issues)

These identifiers are used to categorize and track business events within the application.

Available options:
ipo_announcement,
new_funding_round,
new_investment,
new_product,
new_office,
closing_office,
new_partnership,
increase_in_engineering_department,
increase_in_sales_department,
increase_in_marketing_department,
increase_in_operations_department,
increase_in_customer_service_department,
increase_in_all_departments,
decrease_in_engineering_department,
decrease_in_sales_department,
decrease_in_marketing_department,
decrease_in_operations_department,
decrease_in_customer_service_department,
decrease_in_all_departments,
employee_joined_company,
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,
company_award,
outages_and_security_breaches,
cost_cutting,
merger_and_acquisitions,
lawsuits_and_legal_issues
​
business_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