Skip to main content
POST
Undo a revert batch

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

Idempotency-Key
string

Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.

Maximum string length: 255

Path Parameters

batchId
string
required

Batch id returned by the revert call

Body

application/json
reason
string

Why the undo happened — stored in the audit trail and webhook events. Defaults to a generated message.

Required string length: 3 - 1000
Example:

"Reverted the wrong day — restoring"

preview
boolean
default:false

Dry run: per-account report of what the undo WOULD restore (and which accounts are blocked), nothing changed.

Example:

true

previewLimit
integer

Preview only: check at most this many accounts individually (the oldest first); total still counts every account left to undo. Default: all of them up to 1000, the first 100 above that.

Required range: 1 <= x <= 1000
Example:

100

background
boolean

Run the undo in the background: answer 202 right away and follow progress with GET /revert-batches/{batchId}. Undos of more than 1000 accounts always run in the background. Ignored in previews.

Example:

true

Response

Undo processed (check per-account failures)

success
boolean
Example:

true

message
string
Example:

"Restored 1 account to their pre-revert state"

data
object
Example: