Update Address Book Item

Update the label of an address book entry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates the label of an existing address book entry. Only the label field can be modified.

Request

PATCH /customers/{customer_id}/address_book/{address_book_id}

Request Body

FieldTypeRequiredDescriptionExample
labelstringYesThe new label for the address"my new label"

Response Fields

FieldTypeDescriptionExample
idstringUnique identifier for the entry"ewteqwtqewtqwetqwetqwetq"
addressstringThe cryptocurrency address"bc1qmv4pr0hs4gd3s7chgacccr3m9ajf7xdcf7mfrm"
networkstringThe blockchain network"bitcoin"
labelstringThe updated label"my new label"
createdstringISO 8601 creation timestamp"2021-01-25T20:38:31+00:00"
last_usedstring | nullISO 8601 timestamp of last usenull
ownership_typestring | nullOwnership relationship: self or third_party"self"
beneficiary_full_namestring | nullFull name of the beneficiary when ownership_type is third_partynull

Error Responses

StatusError CodeDescription
400invalid_parametersRequest validation failed
404not_foundAddress book entry not found
Path Params
string
required
string
required
Body Params
string
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json