Labels

Get an account's labels

get

This method returns the account's labels.

Authorizations
Path parameters
account_idintegerRequired

The account's ID

Responses
200
Account object
application/json
get
GET /accounts/{account_id}/labels HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "info": {
      "color": "#fe3423",
      "description": "Flag resources as potentially harmfull"
    },
    "name": "SPAM"
  }
]

Add a Label to the Account matching the ID

post

This post endpoint set the Label matching the ID passed in the payload to the Account matching the ID passed in the url

Authorizations
Path parameters
account_idintegerRequired

The account's ID

Body
label_idintegerRequired

ID of the label to add to the resource

Example: 42
Responses
200
Whether or not the Label has been successfully attached
application/json
post
POST /accounts/{account_id}/labels HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "label_id": 42
}
{
  "success": true
}

Remove a Label to the Account matching the ID

delete

This post endpoint remove the Label from the account matching the IDs passed in url

Authorizations
Path parameters
account_idintegerRequired

The account's ID

label_idintegerRequired

The label's ID

Responses
200
Whether or not the Label has been successfully removed
application/json
delete
DELETE /accounts/{account_id}/labels/{label_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true
}
PreviousHistoryNextNFT Collections