Honeycluster Docs – Add an address to a watchlist

accounts

Add an address to a watchlist

post

/watchlists/{slug}/members

operationId: account-addWatchlistMember

Adds an XRPL address to the watchlist identified by slug. Idempotent — replaces any existing note for the same (watchlist, address) pair.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Path Parameters

Name	Type	Default	Description
`slug` required	string

Request Body

application/json

required

Field	Type	Description
`address` required	string
`note`	string

Example

Json

{
  "address": "string",
  "note": "string"
}

Responses

200

application/json

Successful response

Field	Type	Description
`watchlistId`	string	Parent watchlist id (PK part).
`address`	string	XRPL address in the watchlist (PK part).
`note`	object
`addedAt`	integer	Record creation timestamp, Unix-seconds.

Example

Json

{
  "watchlistId": "00000000-0000-0000-0000-000000000000",
  "address": "string",
  "note": "string",
  "addedAt": 1745798400
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}