Ledger Enterprise
API Documentation V1
API Documentation V1
  • GETTING STARTED
    • Welcome
    • Getting Started
    • Authentication
    • Rate Limits
    • Pagination
  • tutorials
    • Register a new API User
    • First Steps as an API User
    • Generate Reporting API Keys
    • Manage Reporting API Keys
    • TradeLink Integration Guide for Liquidity Providers
  • REFERENCE
    • API reference
      • Accounts
        • Search Accounts
        • Get an Account by ID
        • Addresses
          • [Decprecated] Get Receiving Addresses of an Account
          • Get Receiving Addresses of an Account
          • [Decprecated] Get an address by index for an account
        • Balances
        • Currency
        • History
        • Labels
        • NFT Collections
        • NFT Portfolio
        • NFTs
        • Sync
        • Tokens
        • ERC20 Child Accounts
      • API users
        • Get List of API Users
        • Create an API User
        • Get an API User
        • Register
      • Currencies and Tokens
        • List Currencies
        • List Tokens
        • Get Currency by Name
        • Get a Token by Network and Address
        • Currency Name and Address Pair
      • Digests
        • Search Digests
        • Get Digests by ID
        • Digest History
      • Entities
        • Search Entity
        • Get an Entity by ID
        • Entity History
        • Get the Users of an Entity
      • Groups
        • Search Group
        • Get Group by ID
        • Group History
      • Labels
      • Messages
        • Search Message
        • Get a Message by ID
        • Message History
      • Organization
      • Pledges
        • Search Pledge
        • Get a Pledge by ID
      • Requests
        • Search Request
        • Create Request
        • Get Request by ID
        • Get Request Challenge (Approve)
        • Get Request Challenge (Reject)
        • Approve Request
        • Reject Request
        • Get the Request's Governance Status
      • Settlements
        • Search Settlements
        • Create Settlement
        • Get a Settlement by ID
      • Transactions
        • Search Transaction
        • Create a Transaction
        • Get a Transaction by ID
        • Estimate Transaction Fees
        • Estimate Transaction Fees
        • Approve Transaction
        • Reject Transaction
        • Transaction History
        • Transaction Labels
      • Users
        • Search Users
        • Search User by ID
        • User History
      • Whitelists
        • Search Whitelist
        • Get Whitelist by ID
        • Whitelist History
      • Auth
        • Get JWT Token
        • Refresh JWT Token
      • Compliance
        • Get an Address' Risk Assessment
        • Get an Address' Sanctions
      • Notifications
        • Get Notification Configuration
        • Set Notification Configuration
    • Specification
Powered by GitBook
On this page
  1. REFERENCE
  2. API reference
  3. Accounts

Labels

PreviousHistoryNextNFT Collections

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
404
Account or Label does not exist
application/json
delete
DELETE /accounts/{account_id}/labels/{label_id} HTTP/1.1
Host: 
X-Ledger-API-Key: YOUR_API_KEY
Accept: */*
{
  "success": true
}
  • GETGet an account's labels
  • POSTAdd a Label to the Account matching the ID
  • DELETERemove a Label to the Account matching the ID

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
404
Account not found
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
404
Account or Label does not exist
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
}