Utilities

Rename a whitelisted address

Propose a new name for a whitelisted address.

PATCH
/api/v2/whitelisted-addresses/{id}

Creates a whitelisted address rename proposal in PROPOSED status. Wallet approvers must approve it in the dashboard before the rename is applied.

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key obtained on Settings > API Keys page in Compose UI.

In: header

Path Parameters

id*string

Whitelisted address ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH 'https://compose.finance/api/v2/whitelisted-addresses/{id}' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Content-Type: application/json' \  -d '{    "name": "Updated Wallet Name"  }'
{
  "transactionId": "txn_123456789",
  "status": "PROCESSING",
  "requiresUiAction": true
}
{
  "error": "Invalid request data"
}
{
  "error": "Unauthorized - Invalid or missing API key or session"
}
{
  "error": "Customers feature is not enabled for your organization"
}
{
  "error": "One or more whitelisted addresses were not found"
}
{
  "error": "Invalid request data"
}
{
  "error": "Rate limit exceeded. Please try again later."
}

{
  "error": "Internal server error"
}