---
title: "Alter information of a transaction."
method: POST
path: "/v1/transaction/{id}/alter"
tags: ["Transaction", "Metadata"]
---

# Alter information of a transaction.

`POST /v1/transaction/{id}/alter`

Alter a transaction with a list of actions such as setting status or properties.
The server should either succeed and apply all actions, or fail and apply no action.

## Path parameters

- `id` string, required

## Query parameters

- `delimiter` string, nullable — An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

## Request body

- AlterTransactionRequest — Alter a transaction with a list of actions. The server should either succeed and apply all actions, or fail and apply no action.
  - `id` string[]
  - `actions` AlterTransactionAction[], required
    - `setStatusAction` AlterTransactionSetStatus
      - `status` 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELED'
    - `setPropertyAction` AlterTransactionSetProperty
      - `key` string
      - `value` string
      - `mode` 'OVERWRITE' | 'FAIL' | 'SKIP' — The behavior if the property key already exists. - OVERWRITE (default): overwrite the existing value with the provided value - FAIL: fail the entire operation - SKIP: keep the existing value and skip setting the provided value
    - `unsetPropertyAction` AlterTransactionUnsetProperty
      - `key` string
      - `mode` 'SKIP' | 'FAIL' — The behavior if the property key to unset does not exist. - SKIP (default): skip the property to unset - FAIL: fail the entire operation

## Response `200`

Response of AlterTransaction

- AlterTransactionResponse
  - `status` 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELED', required
  - `properties` unknown

## Other responses

- `400` — Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.
- `401` — Unauthorized. The request lacks valid authentication credentials for the operation.
- `403` — Forbidden. Authenticated user does not have the necessary permissions.
- `404` — A server-side problem that means can not find the specified resource.
- `409` — The request conflicts with the current state of the target resource.
- `503` — The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry.
- `5XX` — A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

## Changes

- **2025-07-29** `40a3bc489d46` — 7 breaking, 14 warning, 14 info
  - the response property `type` became optional for the status `400`
  - the response property `type` became optional for the status `401`
  - the response property `type` became optional for the status `403`
  - the response property `type` became optional for the status `404`
  - …31 more
- **2025-07-25** `8769f8e36bc4` — 2 breaking, 2 info
  - the `id` request property type changed from `string` to `array`
  - removed the required property `id` from the response with the `200` status
  - the request property `id` became optional
  - added the optional property `properties` to the response with the `200` status
- **2025-07-21** `db7569410aa4` — 1 info
  - api tag `Metadata` added
- **2025-07-21** `6790486d1fac` — 12 breaking, 23 warning, 33 info
  - request property `actions/items/setPropertyAction/mode` was restricted to a list of enum values
  - request property `actions/items/setStatusAction/status` was restricted to a list of enum values
  - request property `actions/items/unsetPropertyAction/mode` was restricted to a list of enum values
  - the request property `id` became required
  - …64 more

[Change history](https://skmtc.dev/lance-format/apis/lance-namespace-specification/changes/v1/transaction/:id/alter/post.md)

---

[API](https://skmtc.dev/lance-format/apis/lance-namespace-specification.md) · [All operations](https://skmtc.dev/lance-format/apis/lance-namespace-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lance-format/lance-namespace-specification/revisions/40a3bc489d46/schema)