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 '
{
  "address": "<string>",
  "externalId": "<string>",
  "name": "<string>",
  "networkId": "<string>",
  "accountIds": [
    "<string>"
  ],
  "memo": "<string>"
}
'
{
  "address": "<string>",
  "createdAt": "<string>",
  "externalId": "<string>",
  "name": "<string>",
  "networkId": "<string>",
  "recordId": "<string>",
  "status": "new",
  "workspaceId": "<string>",
  "accountIds": [
    "<string>"
  ],
  "createdBy": "<string>",
  "lastUsedAt": "<string>",
  "memo": "<string>",
  "updatedAt": "<string>",
  "updatedBy": "<string>"
}

Path Parameters

workspaceId
string
required

Body

application/json
address
string
required

Address

externalId
string
required

Address book entry external ID

name
string
required

Name of the address

networkId
string
required

Blockchain Network Id of an address

accountIds
string[]

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

memo
string

Address memo (destination tag for XRP)

Response

OK

address
string
required

Blockchain address string

Example:

"TKAduQVqNaTLyBzVvRrcctY6FFraowJ3Uc"

createdAt
string
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"

networkId
string
required

Currency of an address

Example:

"BTC"

recordId
string
required

Address book record ID

Example:

"gx8df95a09h319dbu79rfora"

status
enum<string>
required
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

createdBy
string

Created by user id

Example:

"e191u51yxnykins6fahdizxy"

lastUsedAt
string

Last used at

Example:

"1749646207296"

memo
string

Address memo (destination tag for XRP)

updatedAt
string

Last updated Updated at timestamp

Example:

"1749646207296"

updatedBy
string

Updated by user id

Example:

"e191u51yxnykins6fahdizxy"