POST/api/v1/remove-whitelist-address

Remove an address from the Address Book

Deletes an address from the workspace Address Book by address, which drops its saved name without changing any token's approved-destination list.

AccessRequires a permission in the workspaceMANAGE_WORKSPACE

Identify the entry by its address, not by an id. The entry stops appearing in the workspace Address Book, so members can no longer pick that address by name.

Nothing on-chain changes. A token that already approved this address still accepts it as a destination, because that approval lives in the token's own whitelist: withdraw it with POST /api/v1/remove-from-contract-whitelist, which the vault's signers must approve. Check GET /api/v1/get-workspace-whitelist to see which tokens currently approve the address, and see Managing whitelisted addresses for the operator view of the same two steps.

Removing the name does not remove the approval

This call only clears the Address Book entry. Tokens that already list the address keep accepting it until each token's own whitelist is changed on-chain.

Body parameters

workspace_idnumberrequired

The workspace whose Address Book to remove from. You must hold MANAGE_WORKSPACE in it.

addressstringrequired

The saved Bitcoin address to remove.

bash

curl -X POST "$SQRL_API/api/v1/remove-whitelist-address" \
  -H "authorization: Bearer $SQRL_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "workspace_id": 342,
        "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"
      }'

const res = await fetch(
  `${process.env.SQRL_API}/api/v1/remove-whitelist-address`,
  {
    method: "POST",
    headers: {
      authorization: `Bearer ${process.env.SQRL_TOKEN}`,
      "content-type": "application/json",
    },
    body: JSON.stringify({
      workspace_id: 342,
      address: "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    }),
  },
);
const { Success } = await res.json();

rust

let res = client
    .post(format!("{}/api/v1/remove-whitelist-address", api_base))
    .bearer_auth(&token)
    .json(&serde_json::json!({
        "workspace_id": 342,
        "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
    }))
    .send()
    .await?;

Response200 OK

{
"Success": true
}

Was this page helpful?