Modify a recipient

PATCH {{baseUrl}}/v1/addressBook/recipients/:id

Body Params

metadata object

  • nickname string Nickname related to the address.

  • email string Email of the user.

  • bns string Blockchain Name Service (e.g. ENS) domain for the address.

Request Body

{"metadata"=>{"nickname"=>"sample nickname", "email"=>"satoshi@circle.com", "bns"=>"sample.circle"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"data":{"id":"2b9f9ed9-ac9d-5f6e-954b-a29e03ee3259","chain":"ETH","address":"0x8381470ed67c3802402dbbfa0058e8871f017a6f","metadata":{"nickname":"sample nickname test","email":"satoshi@circle.com","bns":"sample.circle"},"status":"pending","createDate":"2023-08-17T13:00:14.579175Z","updateDate":"2024-01-17T21:48:06.206438Z"}}