Skip to main content
POST
Correct a past version's stored values

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

config_id
string
required

ID of the record configuration that the record belongs to

id
string
required

Record ID

version
integer
required

The put event's version to act on. A deletion cannot be amended, hidden, erased or restored (400 history_target_not_put).

Body

application/json

Body of POST .../amend. data is merged onto the target version's folded snapshot data exactly as a record update merges (replace: true replaces data wholesale instead). folder, parent_folder, space_id and completed are not amendable.

data
object
required

Corrected field values, merged into the target version's data.

reason
string
required

Required, 1-500 characters after trimming. 400 history_reason_required when empty, history_reason_too_long over 500.

Maximum string length: 500
replace
boolean
default:false

Replace data wholesale instead of merging.

validate
boolean
default:true

Validate the merged result against the current schema. false skips validation.

hidden_fields
string[]

Schema fields to exclude from validation, as on a record update.

Response

The folded entry as it now reads (the amended snapshot, or the unchanged existing entry when nothing changed).

status_code
integer

HTTP status code echoed in the response body.

body
object

One event on a record's history.