Skip to main content
POST
Ownership of a whitelist moves in two steps. The owner proposes a new owner with transferOwnership, and the proposed wallet accepts with acceptOwnership. Send newOwner to build the first, or accept: true to build the second. Record either with Confirm Whitelist Ownership. Until the new owner accepts, the current owner keeps every right over the list, and a later proposal replaces a pending one. A list can never be left without an owner.
A transfer does not change the managers. Every manager keeps listing and removing wallets after the new owner accepts, until the new owner removes it. The build names the managers that stay in MANAGERS_KEEP_LISTING. Remove a manager first with Set Whitelist Manager if it should not keep that power.

Propose a new owner

Only the instance that keeps the list proposes, and its owner wallet signs. When newOwner is not a verified wallet of your instance, the instance that holds that wallet takes over the record once the transfer is accepted. The name goes with it, and so do the manager and transfer rights. Your instance then keeps only what its own wallets can do as managers. The build warns with OWNER_LEAVES_INSTANCE.

Accept a pending transfer

The wallet the pending transfer names signs. Your instance can accept on a list it keeps, or on a list another instance keeps when the pending transfer names one of your verified wallets. Once the proposal is recorded, that list appears under managed on List Whitelists with pendingOwnerWallet set. No pending transfer, or a signer other than the pending owner, is refused with NOT_PENDING_OWNER.

Path Parameters

string
required
The whitelist ID from List Whitelists.

Body Parameters

Send exactly one of newOwner and accept.
string
The wallet to propose as owner. It must differ from the current owner.
boolean
true builds the acceptance of the pending transfer.
string
The wallet that will sign: the owner for a proposal, the pending owner for an acceptance. Omit it to use the verified wallet of your instance in that position.

Response Fields

object

Warnings

Error Codes