Skip to main content
Version: 1.1

Archive a Rule


Endpoint Overview

The "Archive Rule" endpoint allows you to archive, rather than delete, a fraud detection rule. This deactivates the rule from active detection while preserving its historical data.


Archiving a rule ensures it's no longer actively used for fraud detection but keeps the rule's historical data intact. If you're unsure about this action or need further insights into this endpoint, our Support Team is available to assist.

Request Parameters

Path Parameters

The endpoint requires the following path parameter:

  • rule_id: The unique identifier (UUID) of the rule you wish to archive.

Example Request With Path Parameter


Response Parameters

Status CodeStatus MessageDescriptionSchema
204No ContentStandard response for successful HTTP requests when archiving a rule. The server has successfully processed the request and there is no additional content to send in the response payload body.204 No Content - No Response Body
404Not FoundResponse when the specified rule ID does not exist.Problem response
500, 501, 502, 503, 504errorVarious error messages for unsuccessful HTTP requests.Problem response

Code Samples

curl -X DELETE '' \
-H 'Content-Type: application/json' \
-H "authorisation: Bearer $ACCESS_TOKEN"