> ## 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.

# Update prospect 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.


## OpenAPI

````yaml patch /v2/prospects/events/enrollments/{enrollment_id}
openapi: 3.1.0
info:
  title: Partner Service
  version: 0.3.24
servers:
  - url: https://api.explorium.ai
    description: AgentSource Server
security: []
paths:
  /v2/prospects/events/enrollments/{enrollment_id}:
    patch:
      tags:
        - V2Enrollments
      summary: Patch Prospect Enrollment
      operationId: patch_prospect_enrollment
      parameters:
        - required: true
          schema:
            type: string
            title: Enrollment Id
          name: enrollment_id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ProspectEnrollmentPatchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2EnrollmentResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - APIKeyHeader: []
components:
  schemas:
    V2ProspectEnrollmentPatchRequest:
      properties:
        request_context:
          type: 'null'
          title: Request Context
        enrollment_key:
          type: string
          minLength: 4
          title: Enrollment Key
        webhook_id:
          type: string
          title: Webhook Id
        event_types:
          items:
            $ref: '#/components/schemas/ProspectsEventIdentifier'
          type: array
          minItems: 1
        prospect_ids:
          items:
            type: string
            pattern: ^[a-f0-9]{40}$
          type: array
          maxItems: 20
          minItems: 1
          title: Prospect Ids
      additionalProperties: false
      type: object
      title: V2ProspectEnrollmentPatchRequest
    V2EnrollmentResponse:
      properties:
        enrollment_key:
          type: string
          minLength: 4
          title: Enrollment Key
        enrollment_id:
          type: string
          title: Enrollment Id
        webhook_id:
          type: string
          title: Webhook Id
        status:
          $ref: '#/components/schemas/EnrollmentStatus'
        response_context:
          $ref: '#/components/schemas/ResponseContext'
      type: object
      required:
        - enrollment_key
        - enrollment_id
        - webhook_id
        - status
        - response_context
      title: V2EnrollmentResponse
      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
    ProspectsEventIdentifier:
      type: string
      enum:
        - prospect_changed_role
        - prospect_changed_company
        - prospect_job_start_anniversary
      title: ProspectsEventIdentifier
      description: >-
        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.
    EnrollmentStatus:
      type: string
      enum:
        - active
        - paused
      title: EnrollmentStatus
      description: An enumeration.
    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

````