nChain Event API Reference
V.1.4.3 API
V.1.4.3 API
  • About
  • Version History
  • API reference
    • Records
      • Status
      • Content
      • Match
    • Linkedrecords
      • Update
      • Delete
      • Status
      • Content
      • Match
      • Navigate
  • Specification
Powered by GitBook
On this page
  1. API reference
  2. Linkedrecords

Delete

PreviousUpdateNextStatus

Delete linked record

post

Delete/Terminate/Finalise the supplied linked record by linking it to a new empty transaction.

The transaction will be published to the blockchain asynchronously. Use Get linked record status to find out when it has been confirmed.

Path parameters
txIdstringRequired

The transaction id of the linked record to delete

Query parameters
updateTokenstringOptional

Optional, if specified it must be the updateToken returned from the creation of the supplied linked record.

Header parameters
x-api-keystringRequired

{your-API-key}

Responses
200
The transaction published.
400
Invalid request. The Response is a JSON structure conforming to https://tools.ietf.org/html/rfc7807. It contains the following details: - errorCode: which can be one of: - CONTENT_LENGTH_LIMIT_EXCEEDED: Request body was bigger than configured limit for this service - TX_HASH_PARM_INVALID: Provided transaction hash parameter is not a valid blockchain transaction hash - TX_NOT_AN_EVENT_TRANSACTION: Provided transaction hash is not an nChain Event record transaction. This error cannot occur if updateToken is specified as there is no need to fetch the transaction in order to get information about the output link to use.Actual acceptance by the blockchain will probably still fail. - TX_NOT_LINKABLE: Transaction is not linkable - UPDATE_TOKEN_PARAM_INVALID: updatable request parameter is set to invalid value
404
The transaction cannot be read from the blockchain. It could either still be in the process of publishing or the blockchain has rejected it. This error cannot occur if updateToken is specified as there is no need to fetch the transaction in order to get information about the output link to use. Actual acceptance by the blockchain can still fail for the same reasons that fetching would fail.
500
An internal error occurred. Retry later. The Response is a JSON structure conforming to https://tools.ietf.org/html/rfc7807
post
POST /api/v1/linkedrecords/{txId}/delete HTTP/1.1
Host: {your-URL}
x-api-key: text
Accept: */*

{
  "txId": "text"
}