Skip to main content
POST
Bulk revert accounts to a trading day or an instant

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

Body

application/json
reason
string
required

Why — audit trail, account metadata, webhooks

Required string length: 3 - 1000
Example:

"Data feed outage"

tradingDay
string

END-OF-DAY restore: Chicago trading day (YYYY-MM-DD) to revert TO. One of tradingDay / revertTo; with an audience and neither given, the accounts are restored to audience.from.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-07"

revertTo
string

POINT-IN-TIME restore: the exact instant (ISO 8601, UTC) every targeted account is restored to — typically the moment the outage began. See the single-account endpoint for how the state at an instant is reconstructed.

Example:

"2026-09-08T13:30:00Z"

accountIds
string[]

Specific accounts to revert (max 5000 per call; more than 1000 runs in the background)

Required array length: 1 - 5000 elements
allAccounts
enum<boolean>

Revert every account in the organization with activity after the restore point (later trades or snapshots) — including accounts created during the outage day itself. Untouched accounts are skipped.

Available options:
true
audience
object

Target the accounts an outage window actually touched, instead of naming them. Only non-voided activity counts. The response reports how many matched; an empty audience returns 200 with reverted: 0 (nothing to do is not an error).

preview
boolean
default:false

Dry run: per-account report of what WOULD happen, nothing changed. Use it to build the confirmation screen before an org-wide revert.

Example:

true

previewLimit
integer

Preview only: report at most this many accounts individually (the first ones matched); total still counts every match. Default: all of them up to 1000 matches, the first 100 above that.

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

100

background
boolean

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

Example:

true

Response

Bulk revert processed (check per-account failures)

success
boolean
Example:

true

message
string
Example:

"Reverted 42 accounts to 2026-07-07"

data
object
Example: