Update Businesses Enrollments

Update enrollments for businesses

Endpoint: PATCH /v1/businesses/events/enrollments

Description

Update an existing enrollment.

How It Works

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.


Query Parameters
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)

Example Request (cURL)
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",
  "enrollment_id": "en_7b429a01",
  "business_ids": [
    "8adce3ca1cef0c986b22310e369a0793",
    "665595bbb4e724de6f8bc705a5b84753"
  ],
  "event_types": [
    "ipo_announcement",
    "new_funding_round",
    "new_product"
  ]
}'
Example Response
{
  "request_context": {
    "correlation_id": "1234",
    "request_status": "success",
    "time_took_in_seconds": 0.515
  },
  "enrollment_key": "my_b2b_saas_monitor",
  "enrollment_id": "en_7b429a01"
}
Language
Credentials
Click Try It! to start a request and see the response here!