Skip to main content
PATCH
Patch Business Enrollment
Updates any mutable field — webhook_id, enrollment_key, event_types, or the entity ID list. Re-pointing a paused enrollment to an active webhook reactivates it without re-enrolling entities.

Authorizations

api_key
string
header
required

Path Parameters

enrollment_id
string
required

Body

application/json
request_context
null
enrollment_key
string
Minimum string length: 4
webhook_id
string
event_types
enum<string>[]
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 array length: 1 - 20 elements
Pattern: ^[a-f0-9]{32}$

Response

Successful Response

This is base response model for all responses in partner service.

enrollment_key
string
required
Minimum string length: 4
enrollment_id
string
required
webhook_id
string
required
status
enum<string>
required

An enumeration.

Available options:
active,
paused
response_context
ResponseContext · object
required