Removes signups from the whitelist, so those identities can no longer register.
💡 Removing from the whitelist does not ban anyone — it only revokes the allow entry. To block an identity, add it to the blacklist.
method is "removeFromWhitelist".
| Field | Type | Required | Description |
|---|---|---|---|
signups |
Array of Signup | Yes | The signup identities to remove. |
app_id |
String | Yes | The app the whitelist belongs to. |
reference |
String | Yes | Your id for this request. Echoed back in the response. |
| Requirement | Why |
|---|---|
"Signup Management" permission |
Needed to manage whitelist and blacklist. |
| User Whitelist enabled | Turn on the Use Whitelist flag under Web Admin → Signup Settings → Signup Filter, or filtering is not enforced. |
👉 This feature is limited to apps created with the nandbox app builder.
| Field | Type | Returned | Description |
|---|---|---|---|
method |
String | Yes | "removeFromWhitelist_ack" |
signups |
Array of Signup | Yes | The signups that were removed. |
app_id |
String | Yes | Echoed from the request. |
reference |
String | Optional | Echoed from the request. |
| SDK | Call | Callback |
|---|---|---|
| Java | api.deleteWhiteList(users, appId, reference); |
onDeleteWhiteList(WhiteList whiteList) |
| JavaScript | api.deleteWhiteList(users, appId, reference); |
onDeleteWhiteList(whiteList) |
| Python | napi.delete_white_list(users=users, app_id=app_id, reference=reference) |
on_remove_white_list(self, white_list) |
{
"method": "removeFromWhitelist",
"app_id": "90090684293000559",
"reference": 111111148,
"signups": ["[email protected]"]
}
List<String> users = new ArrayList<>();
users.add("[email protected]");
api.deleteWhiteList(users, "90090684293000559", "111111148");
let users = ["[email protected]"];
api.deleteWhiteList(users, "90090684293000559", "111111148");
users = ["[email protected]"]
napi.delete_white_list(users=users, app_id="90090684293000559", reference="111111148")