> ## Documentation Index > Fetch the complete documentation index at: https://developers.explorium.ai/llms.txt > Use this file to discover all available pages before exploring further. # Add Businesses Enrollments > Add enrollments for businesses ## 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. | Field | Type | Description | | :-------------- | :----- | :------------------------------------------------------------------------ | | enrollment\_key | String | A unique identifier for this enrollment | | business\_ids | Array | List of Business IDs to monitor for events | | event\_types | Array | Types of events to monitor (e.g., ipo\_announcement, new\_funding\_round) | ```shell Bash theme={null} 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 JSON theme={null} { "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. ## OpenAPI ````yaml post /v1/businesses/events/enrollments openapi: 3.1.0 info: title: Partner Service version: 0.2.349 servers: - url: https://api.explorium.ai description: AgentSource Server security: [] paths: /v1/businesses/events/enrollments: post: tags: - Businesses summary: Add Businesses Enrollments description: Add enrollments for businesses operationId: add_businesses_enrollments requestBody: content: application/json: schema: $ref: '#/components/schemas/BusinessesEnrollmentsAddRequest' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BusinessesEnrollmentsAddResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - APIKeyHeader: [] components: schemas: BusinessesEnrollmentsAddRequest: properties: request_context: type: object title: Request Context example: null nullable: true enrollment_key: type: string minLength: 4 title: Enrollment Key event_types: items: $ref: '#/components/schemas/BusinessesEventIdentifier' type: array minItems: 1 business_ids: items: type: string pattern: ^[a-f0-9]{32}$ type: array maxItems: 20 minItems: 1 title: Business Ids additionalProperties: false type: object required: - enrollment_key - event_types - business_ids title: BusinessesEnrollmentsAddRequest BusinessesEnrollmentsAddResponse: properties: response_context: $ref: '#/components/schemas/ResponseContext' enrollment_key: type: string minLength: 4 title: Enrollment Key enrollment_id: type: string title: Enrollment Id type: object required: - response_context - enrollment_key - enrollment_id title: BusinessesEnrollmentsAddResponse description: 'This is base response model for all responses in partner service. ' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError BusinessesEventIdentifier: type: string enum: - 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 title: BusinessesEventIdentifier description: >- 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. ResponseContext: properties: correlation_id: type: string title: Correlation Id request_status: $ref: '#/components/schemas/RequestStatus' time_took_in_seconds: type: number title: Time Took In Seconds type: object required: - correlation_id - request_status - time_took_in_seconds title: ResponseContext ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError RequestStatus: type: string enum: - success - miss - failure title: RequestStatus description: >- The `RequestStatus` class is an enumeration that defines the possible statuses of a request. This enum is used to indicate whether a request was successful, missed, or failed. It ensures consistent handling of request statuses across the application. Attributes: SUCCESS: Indicates that the request was successfully processed. MISS: Indicates that the request did not find any matching data. FAILURE: Indicates that the request encountered an error or failure. securitySchemes: APIKeyHeader: type: apiKey in: header name: api_key ````