Skip to main content
DELETE
Delete Prospects Enrollments

Description

The Delete Prospect Events Enrollment endpoint allows you to cancel an active prospect monitoring configuration. This is useful when you no longer need to track certain individuals or when a monitoring strategy needs to be reconfigured.
Input: Specify the enrollment_id you wish to cancel.
Processing: The system removes the enrollment configuration.
Output: A confirmation of successful deletion.
Bash
JSON

Authorizations

api_key
string
header
required

Body

application/json
enrollment_id
string
required
request_context
Request Context · object | null
Example:

null

Response

Successful Response

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

response_context
ResponseContext · object
required
status
enum<string>

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.

Available options:
success,
miss,
failure