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

Update an existing enrollment.
  • Input: Define parameters including enrollment_key and enrollment_id to update, and updated business_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
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 PATCH \
  "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",
  "enrollment_id": "en_7b429a01",
  "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"
}

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