Skip to main content
Use the playground below to try this endpoint directly, or review the OpenAPI details in the right panel. This endpoint lets you make targeted updates to an existing address. All fields are optional — only include what you want to change. Endpoint 
PATCH https://api.brale.xyz/accounts/{account_id}/addresses/{address_id}

​
Updatable fields

FieldTypeDescription
namestringRename the address.
statusstring"archived" to archive, "active" to unarchive (external addresses only — custodial addresses cannot be unarchived).
additional_transfer_typesarray of stringsAdd new rails to the address (e.g. "wire", "solana"). For bank addresses, supply bank_address and beneficiary_address before adding wire.
bank_addressobjectStreet address of the bank. Required for bank addresses before enabling wire.
beneficiary_addressobjectStreet address of the beneficiary. Required for bank addresses before enabling wire.

​
Add transfer types to an existing address

To add new rails to an existing address (for example, adding ach_credit and same_day_ach_credit to an address), send a PATCH to the same endpoint with additional_transfer_types: 
PATCH https://api.brale.xyz/accounts/{account_id}/addresses/{address_id}
Request
{
  "additional_transfer_types": ["ach_credit", "same_day_ach_credit"]
}
additional_transfer_types is merged into the address’s existing transfer_types. You do not need to resend the full existing list — send only the rails you want to add. Sending a transfer type that is already enabled is idempotent.

​
Error responses

  • 400 — invalid or incompatible transfer types, attempting to archive a pending address, attempting to unarchive a custodial address, or invalid status value.
  • 404 — address not found or not owned by the account.
Required scope: addresses:write