Skip to main content
POST
Create Prospect Enrollment
Requires a webhook_id of an active v2 webhook in your scope — unknown IDs return 404, a missing webhook_id or wrong scope/status returns 422; delivery is never silently re-pointed. Up to 20 IDs per request, unlimited total across requests.

Authorizations

api_key
string
header
required

Body

application/json
enrollment_key
string
required
Minimum string length: 4
webhook_id
string
required
event_types
enum<string>[]
required
Minimum array length: 1

The ProspectsEventIdentifier class is an enumeration that defines event identifiers related to prospects.

This enum is used to categorize and track events associated with prospects, such as:

  • Role changes (e.g., when a prospect changes their role within a company)
  • Company changes (e.g., when a prospect moves to a new company)
  • Job anniversaries (e.g., celebrating the anniversary of a prospect's job start date)

These identifiers ensure consistent handling and classification of prospect-related events across the application.

Available options:
prospect_changed_role,
prospect_changed_company,
prospect_job_start_anniversary
prospect_ids
string[]
required
Required array length: 1 - 20 elements
Pattern: ^[a-f0-9]{40}$
request_context
null

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