Skip to main content
POST
/
workspaces
/
{workspaceId}
/
address-book-records
Create Address Book record
curl --request POST \
  --url https://api.bron.org/workspaces/{workspaceId}/address-book-records \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalId": "<string>",
  "name": "<string>",
  "accountIds": [
    "<string>"
  ],
  "address": "<string>",
  "imageId": "<string>",
  "memo": "<string>",
  "networkId": "<string>",
  "tag": "<string>"
}
'
{
  "createdAt": "<string>",
  "externalId": "<string>",
  "name": "<string>",
  "recordId": "<string>",
  "workspaceId": "<string>",
  "accountIds": [
    "<string>"
  ],
  "address": "<string>",
  "createdBy": "<string>",
  "imageId": "<string>",
  "lastUsedAt": "<string>",
  "memo": "<string>",
  "networkId": "<string>",
  "tag": "<string>",
  "updatedAt": "<string>",
  "updatedBy": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.bron.org/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
workspaceId
string
required

Body

application/json
​
externalId
string
required

Address book entry external ID

​
name
string
required

Name of the address

​
accountIds
string[]

Comma-separated account ids, if address set for particular accounts

​
address
string

Address

​
bankDetails
object

Bank details (for bank type records)

​
imageId
string

Workspace image ID (for tag type records)

​
memo
string

Address memo (destination tag for XRP)

​
networkId
string

Blockchain Network Id of an address

​
recordType
enum<string>

Record type: address, tag, or bank. See details

Available options:
address,
tag,
bank
​
tag
string

Workspace tag (for tag type records)

Response

OK

​
createdAt
string<date-time-millis>
required

Created at timestamp

Example:

"1749646207296"

​
externalId
string
required

Address book entry external ID

Example:

"ki50iq4iotxmuv1ihgw9q6u3"

​
name
string
required

Name of the address

Example:

"My address"

​
recordId
string
required

Address book record ID

Example:

"gx8df95a09h319dbu79rfora"

​
recordType
enum<string>
required

Record type: address, tag, or bank. See details

Available options:
address,
tag,
bank
​
status
enum<string>
required

See details

Available options:
new,
active,
rejected,
deleted
​
workspaceId
string
required

Workspace ID

Example:

"e191u51yxnykins6fahd"

​
accountIds
string[]

Comma-separated account ids, if address set for particular accounts

​
address
string

Blockchain address string

Example:

"TKAduQVqNaTLyBzVvRrcctY6FFraowJ3Uc"

​
createdBy
string

Created by user id

Example:

"e191u51yxnykins6fahdizxy"

​
imageId
string

Workspace image ID (for tag type records)

​
lastUsedAt
string<date-time-millis>

Last used at

Example:

"1749646207296"

​
memo
string

Address memo (destination tag for XRP)

​
networkId
string

Currency of an address

Example:

"BTC"

​
tag
string

Workspace tag (for tag type records)

Example:

"$myworkspace"

​
updatedAt
string<date-time-millis>

Last updated Updated at timestamp

Example:

"1749646207296"

​
updatedBy
string

Updated by user id

Example:

"e191u51yxnykins6fahdizxy"