Skip to main content
POST
Create Address Book record

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)

email
string

Recipient email notified when assets are sent to this record

imageId
string

Workspace image ID (for tag type records)

isFavorite
boolean

Whether the record is in the workspace favorites

labels
string[]

Labels attached to the record, shared by all workspace members

Example:

"Personal,Business"

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<external-text>
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
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

activatedAt
string<date-time-millis>

Activation timestamp — when the record was approved

Example:

"1749646207296"

address
string

Blockchain address string

Example:

"TKAduQVqNaTLyBzVvRrcctY6FFraowJ3Uc"

createdBy
string

Created by user id

Example:

"e191u51yxnykins6fahdizxy"

email
string<external-text>

Recipient email notified when assets are sent to this record

imageId
string

Workspace image ID (for tag type records)

isFavorite
boolean

Whether the record is in the workspace favorites

labels
string[]

Labels attached to the record, shared by all workspace members

Example:

"Personal,Business"

lastUsedAt
string<date-time-millis>

Last used at

Example:

"1749646207296"

memo
string<external-text>

Address memo (destination tag for XRP)

networkId
string

Currency of an address

Example:

"BTC"

tag
string<external-text>

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"