Skip to main content
POST
/
v0
/
tags
/
{tag_id}
/
clear
Remove a tag from a list of transactions
curl --request POST \
  --url https://api.sandbox.teal.dev/v0/tags/{tag_id}/clear \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '
{
  "transactions": [
    {
      "ledger_id": "<string>",
      "transaction_id": "<string>"
    }
  ]
}
'
{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>",
  "error_code": "invalid_date"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
teal-instance-id
string
required

The teal instance ID

Path Parameters

​
tag_id
string
required

The tag ID

Body

application/json
​
transactions
TransactionRef · object[]
required

A list of transactions from which to remove a given tag.

Example:
[
  {
    "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
    "transaction_id": "txn_NCB2xo5"
  }
]

Response

Successful Response