Skip to content
em sa em sa

Purge Deals

POST
/api/superadmin/purge_deals
 
curl --request POST \
  --url https://example.com/api/superadmin/purge_deals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "example", "deal_id": "example", "org_id": "example", "include_checkpoints": false, "exclude_active_within_secs": 1, "dry_run": true }'

Purge per-deal Redis state (Canvas sessions, locks, presence, events, image crops, digitization cache, intake summaries, doc readiness, deal-intel cache, brush findings).

LangGraph checkpoint keys are NOT purged unless include_checkpoints is true — this avoids aborting in-flight synthesis runs.

Modes: “all” — purge every deal in Redis. Use exclude_active_within_secs to skip deals with recent canvas:events activity. “by_deal” — purge a single deal_id (org_id optional but recommended).

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
PurgeDealsBody

Request body for /api/superadmin/purge_deals.

object
mode
required
Mode
string
deal_id
Any of:
string
org_id
Any of:
string
include_checkpoints
Include Checkpoints
boolean
exclude_active_within_secs
Any of:
integer
dry_run
Dry Run
boolean
default: true

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
Response Purge Deals Api Superadmin Purge Deals Post
object
key
additional properties
any
Example generated
{}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}