Skip to main content
DELETE
/
v1
/
businesses
/
events
/
enrollments
Delete Businesses Enrollments
curl --request DELETE \
  --url https://api.explorium.ai/v1/businesses/events/enrollments \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "enrollment_id": "<string>",
  "request_context": null
}
'
{
  "response_context": {
    "correlation_id": "<string>",
    "request_status": "success",
    "time_took_in_seconds": 123
  },
  "status": "success"
}

​
Description

The Delete Business Events Enrollment endpoint allows you to cancel an active event monitoring configuration. This is useful when you no longer need to track certain businesses 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.
FieldTypeDescription
enrollment_idStringThe unique identifier of the enrollment to delete
Bash
curl -X DELETE \
  "https://api.explorium.ai/v1/businesses/events/enrollments" \
  -H "API_KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "enrollment_id": "en_7b429a01"
}'
JSON
{
  "status": "success"
}

Authorizations

​
api_key
string
header
required

Body

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

null

Response

Successful Response

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

​
response_context
ResponseContext · object
required
​
status
enum<string>
default:success

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