Skip to main content
PUT
/
address_books
/
{entry_id}
import cobo_waas2
from cobo_waas2.models.address_book import AddressBook
from cobo_waas2.models.update_address_book_param import UpdateAddressBookParam
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.AddressBooksApi(api_client)
    entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    update_address_book_param = cobo_waas2.UpdateAddressBookParam(chain_ids=["ETH"])

    try:
        # Update Address Book entry
        api_response = api_instance.update_address_book_by_id(
            entry_id, update_address_book_param=update_address_book_param
        )
        print("The response of AddressBooksApi->update_address_book_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling AddressBooksApi->update_address_book_by_id: %s\n"
            % e
        )

// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.AddressBooksApi;
import com.cobo.waas2.model.*;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Select the development environment. To use the production environment, replace `Env.DEV` with
    // `Env.PROD
    defaultClient.setEnv(Env.DEV);

    // Replace `<YOUR_PRIVATE_KEY>` with your private key
    defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
    AddressBooksApi apiInstance = new AddressBooksApi();
    UUID entryId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
    UpdateAddressBookParam updateAddressBookParam = new UpdateAddressBookParam().chainIds(Arrays.asList("ETH"));
    try {
      AddressBook result = apiInstance.updateAddressBookById(entryId, updateAddressBookParam);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AddressBooksApi#updateAddressBookById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

package main

import (
	"context"
	"fmt"
	coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
	"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
	"os"
)

func main() {
	entryId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
	updateAddressBookParam := *coboWaas2.NewUpdateAddressBookParam([]string{"ChainIds_example"})

	configuration := coboWaas2.NewConfiguration()
	// Initialize the API client
	apiClient := coboWaas2.NewAPIClient(configuration)
	ctx := context.Background()

	// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
	ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
	// Replace `<YOUR_PRIVATE_KEY>` with your private key
	ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
		Secret: "<YOUR_PRIVATE_KEY>",
	})
	resp, r, err := apiClient.AddressBooksAPI.UpdateAddressBookById(ctx, entryId).
		UpdateAddressBookParam(updateAddressBookParam).
		Execute()
	if err != nil {
		fmt.Fprintf(
			os.Stderr,
			"Error when calling `AddressBooksAPI.UpdateAddressBookById``: %v\n",
			err,
		)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateAddressBookById`: AddressBook
	fmt.Fprintf(os.Stdout, "Response from `AddressBooksAPI.UpdateAddressBookById`: %v\n", resp)
}

const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.AddressBooksApi();
const entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const opts = {
  UpdateAddressBookParam: CoboWaas2.UpdateAddressBookParam.constructFromObject({
    chain_ids: ["ETH"],
  }),
};
apiInstance.updateAddressBookById(entry_id, opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

{
  "org_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "entry_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "address": "0x570f02f2b5fcf3ac56fb6703bd7039c0c9e33460",
  "label": "test",
  "memo": "9d4773eb",
  "wallet_name": "Example Wallet",
  "wallet_type": "Custodial",
  "wallet_subtype": "Asset",
  "chain_ids": [
    "ETH"
  ],
  "email": "[email protected]",
  "encoding": "ENCODING_P2PKH"
}
{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}
{
"error_code": 123,
"error_message": "<string>",
"error_id": "0b6ddf19083c4bd1a9ca01bec44b24dd"
}
Try Cobo WaaS Skill in your AI coding assistant (Claude Code, Cursor, etc.). Describe your needs in natural language to auto-generate production-ready SDK code and debug faster 🚀
import cobo_waas2
from cobo_waas2.models.address_book import AddressBook
from cobo_waas2.models.update_address_book_param import UpdateAddressBookParam
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.AddressBooksApi(api_client)
    entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    update_address_book_param = cobo_waas2.UpdateAddressBookParam(chain_ids=["ETH"])

    try:
        # Update Address Book entry
        api_response = api_instance.update_address_book_by_id(
            entry_id, update_address_book_param=update_address_book_param
        )
        print("The response of AddressBooksApi->update_address_book_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling AddressBooksApi->update_address_book_by_id: %s\n"
            % e
        )

// Import classes:
import com.cobo.waas2.ApiClient;
import com.cobo.waas2.ApiException;
import com.cobo.waas2.Configuration;
import com.cobo.waas2.Env;
import com.cobo.waas2.api.AddressBooksApi;
import com.cobo.waas2.model.*;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    // Select the development environment. To use the production environment, replace `Env.DEV` with
    // `Env.PROD
    defaultClient.setEnv(Env.DEV);

    // Replace `<YOUR_PRIVATE_KEY>` with your private key
    defaultClient.setPrivKey("<YOUR_PRIVATE_KEY>");
    AddressBooksApi apiInstance = new AddressBooksApi();
    UUID entryId = UUID.fromString("f47ac10b-58cc-4372-a567-0e02b2c3d479");
    UpdateAddressBookParam updateAddressBookParam = new UpdateAddressBookParam().chainIds(Arrays.asList("ETH"));
    try {
      AddressBook result = apiInstance.updateAddressBookById(entryId, updateAddressBookParam);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AddressBooksApi#updateAddressBookById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

package main

import (
	"context"
	"fmt"
	coboWaas2 "github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2"
	"github.com/CoboGlobal/cobo-waas2-go-sdk/cobo_waas2/crypto"
	"os"
)

func main() {
	entryId := "f47ac10b-58cc-4372-a567-0e02b2c3d479"
	updateAddressBookParam := *coboWaas2.NewUpdateAddressBookParam([]string{"ChainIds_example"})

	configuration := coboWaas2.NewConfiguration()
	// Initialize the API client
	apiClient := coboWaas2.NewAPIClient(configuration)
	ctx := context.Background()

	// Select the development environment. To use the production environment, replace coboWaas2.DevEnv with coboWaas2.ProdEnv
	ctx = context.WithValue(ctx, coboWaas2.ContextEnv, coboWaas2.DevEnv)
	// Replace `<YOUR_PRIVATE_KEY>` with your private key
	ctx = context.WithValue(ctx, coboWaas2.ContextPortalSigner, crypto.Ed25519Signer{
		Secret: "<YOUR_PRIVATE_KEY>",
	})
	resp, r, err := apiClient.AddressBooksAPI.UpdateAddressBookById(ctx, entryId).
		UpdateAddressBookParam(updateAddressBookParam).
		Execute()
	if err != nil {
		fmt.Fprintf(
			os.Stderr,
			"Error when calling `AddressBooksAPI.UpdateAddressBookById``: %v\n",
			err,
		)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateAddressBookById`: AddressBook
	fmt.Fprintf(os.Stdout, "Response from `AddressBooksAPI.UpdateAddressBookById`: %v\n", resp)
}

const CoboWaas2 = require("@cobo/cobo-waas2");
// Initialize the API client
const apiClient = CoboWaas2.ApiClient.instance;
// Select the development environment. To use the production environment, replace `Env.DEV` with `Env.PROD`
apiClient.setEnv(CoboWaas2.Env.DEV);
// Replace `<YOUR_PRIVATE_KEY>` with your private key
apiClient.setPrivateKey("<YOUR_PRIVATE_KEY>");
// Call the API
const apiInstance = new CoboWaas2.AddressBooksApi();
const entry_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const opts = {
  UpdateAddressBookParam: CoboWaas2.UpdateAddressBookParam.constructFromObject({
    chain_ids: ["ETH"],
  }),
};
apiInstance.updateAddressBookById(entry_id, opts).then(
  (data) => {
    console.log("API called successfully. Returned data: " + data);
  },
  (error) => {
    console.error(error);
  },
);

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

entry_id
string<uuid>
required

The Address Book entry ID.

Body

application/json

The request body of the update Address Book operation.

The request body to update Address Book.

chain_ids
string[]
required

A list of chain IDs.

Example:

"ETH"

memo
string

Optional memo or tag required by some chains.

Example:

"9d4773eb"

label
string

A user-defined label for the address.

Example:

"test"

email
string

Email of the address owner.

Response

Successfully updated Address Book.

The information of an Address Book entry.

org_id
string<uuid>
required

Organization ID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

entry_id
string<uuid>
required

Address Book entry ID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

address
string
required

Wallet address.

Example:

"0x570f02f2b5fcf3ac56fb6703bd7039c0c9e33460"

label
string
required

A user-defined label for the address.

Example:

"test"

memo
string

Optional memo or tag required by some chains.

Example:

"9d4773eb"

wallet_name
string

Wallet name.

Example:

"Example Wallet"

wallet_type
enum<string>

The wallet type. Possible values include:

Available options:
Custodial,
MPC,
SmartContract,
Exchange
Example:

"Custodial"

wallet_subtype
enum<string>

The wallet sub-type. Possible values include:

  • Asset: Custodial Wallets (Asset Wallets).
  • Web3: Custodial Wallets (Web3 Wallets).
  • Org-Controlled: MPC Wallets (Organization-Controlled Wallets).
  • User-Controlled: MPC Wallets (User-Controlled Wallets).
  • Safe{Wallet}: Smart Contract Wallets (Safe).
  • Main: Exchange Wallets (Main Account).
  • Sub: Exchange Wallets (Sub Account).

Each wallet sub-type requires a different set of properties. Switch between the above tabs for details.

Available options:
Asset,
Web3,
Org-Controlled,
User-Controlled,
Safe{Wallet},
Main,
Sub
Example:

"Asset"

chain_ids
string[]

A list of chain IDs.

email
string

Email of the address owner.

encoding
enum<string>

The address encoding formats. This property only applies to blockchains that have a similar architecture to Bitcoin.

Available options:
ENCODING_P2PKH,
ENCODING_P2SH_P2WPKH,
ENCODING_BECH32,
ENCODING_P2PKH_UNCOMPRESSED,
ENCODING_P2SH_P2MS,
ENCODING_P2SH_P2WSH_P2MS,
ENCODING_P2TR,
ENCODING_ADA_BYRON,
ENCODING_ADA_SHELLEY,
ENCODING_DEFAULT
Example:

"ENCODING_P2PKH"