Invalidate windows

POST /success_rate.SuccessRateCalculator/InvalidateWindows

Invalidate success rate windows for an entity.

cURL

curl --request POST \
  --url https://api.example.com/success_rate.SuccessRateCalculator/InvalidateWindows \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-profile-id: <x-profile-id>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "id": "merchant1"
}
'

Response (200)

application/json

{
  "status": "WINDOW_INVALIDATION_SUCCEEDED"
}

Headers

• x-tenant-id (string, required)

• x-profile-id (string, required)

• x-api-key (string, required)

Body

Content-Type: application/json

• id (string, required) Entity identifier for which to invalidate windows Example: "merchant1"

Response

• 200 application/json — Windows invalidated successfully

Response fields:

• status (enum, required) — Status of the window invalidation operation Available options:

  • WINDOW_INVALIDATION_SUCCEEDED

  • WINDOW_INVALIDATION_FAILED

Edit & raise an issue on the docs

• Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/intelligent-router-api-reference/success-rate/invalidate-windows.mdx

• Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/intelligent-router-api-reference/success-rate/invalidate-windows

Related:

• Update success rate window: https://api-reference.hyperswitch.io/intelligent-router-api-reference/success-rate/update-success-rate-window

• Fetch entity and global success rates: https://api-reference.hyperswitch.io/intelligent-router-api-reference/success-rate/fetch-entity-and-global-success-rates