POST `/api/v1/batches/{id}/undo`

Undo an applied batch (unless later trades depend on it).

Scope data:write
Idempotency-Key
operationId dataUndo

The token needs the scope data:write, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Idempotency-Key. Send a unique Idempotency-Key (up to 255 characters, e.g. a UUID) with every POST. Retrying with the same key and body replays the first answer for 24 hours, so a timeout never creates a second order; the same key with a different body is refused (idempotency_key_reused).

Request

POST /api/v1/batches/{id}/undo

Path parameters

Name	Description	Example
`id`	The id of the batche.	`311`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token
`Idempotency-Key`	yes	A unique string up to 255 characters (a UUID). Idempotency

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl -X POST "https://vestoris.com/api/v1/batches/311/undo" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11'

Python (requests)

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/batches/311/undo",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/batches/311/undo", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: Batch. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`dataset`	string	The data set: securities, accounts, positions, lots, cash, prices, fx, corporate_actions, issuers, brokers, benchmarks…
`status`	string	staged, held, applied, undone, rejected or discarded.
`source`	string	upload, feed, api, bundle or ai_suggestion.
`mode`	string	"upsert" (default) or "full" (records missing from the file are inactivated).
`file_name`	string	The file's name.
`sha256`	string	SHA-256 of the file.
`business_date`	date or null	The business date the data is for (YYYY-MM-DD).
`counts`	object	Rows by outcome: new, changed, unchanged, rejected, deleted.
`message`	string	A message in plain words.
`hold_reason`	string or null	Why the batch is held for review.
`created_at`	date-time or null	When it was created.
`applied_at`	date-time or null	When it was applied.
`undone_at`	date-time or null	When it was undone.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "1042",
    "dataset": "prices",
    "status": "staged",
    "source": "api",
    "mode": "upsert",
    "file_name": "ACME_PRICE_20261027_001.xml",
    "sha256": "e3b0…",
    "business_date": "2026-10-27",
    "counts": {
        "new": 3,
        "changed": 12,
        "unchanged": 580,
        "rejected": 1
    },
    "message": "",
    "hold_reason": null,
    "created_at": "2026-10-27T14:30:00Z",
    "applied_at": "2026-10-27T14:30:00Z",
    "undone_at": null
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
200 / 201	The same Idempotency-Key again: the first answer is replayed (24 hours)
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
409	Not possible in the current state	`invalid_transition` `conflict` `idempotency_in_progress`
422	Validation failed (the detail says which field), or blocked	`validation_failed` `idempotency_key_reused`
428	A required header is missing	`idempotency_key_required`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/batches/311/undo"
}

On the screens

The same thing in the app is explained in:

Load history