Skip to main content
PATCH
Update funding address

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
address_id
string
required

Identifier of the user-added funding address to rename.

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

Body

application/json

New label to apply to a user-added funding address.

name
string
required

New partner-provided label for the funding address. It must be unique across the account owner's withdrawal addresses, regardless of funding method. Surrounding whitespace is removed, and whitespace-only labels are rejected.

Required string length: 1 - 64

Response

Funding address renamed.