Skip to main content
PUT
Update Funding Address

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

API-Nonce
string
header
required

The "API-Nonce" header should contain an always-increasing 64-bit integer, most commonly a Unix timestamp in milliseconds. Each request must use a nonce greater than the nonce of the previous request signed with the same API key.

Path Parameters

id
string
required

Unique identifier of the address to update.

Pattern: ^AB[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{6}$

Query Parameters

account_id
string

Account ID

Body

application/json

Request to update the name and/or description of an existing funding address.

name
string

User provided name for the address. Must be unique and contain at least one non-whitespace character. Surrounding whitespace is removed.

Minimum string length: 1
description
string

User provided description of the address.

Response

200 - application/json
verified
boolean
required

Whether the address is verified and ready for use.