Removes signups from the blacklist, unblocking those identities.

💡 Unblocking does not grant access on its own. If the whitelist is enforced, the identity still has to be on it.

Request

method is "removeFromBlacklist".

Field Type Required Description
signups Array of Signup Yes The signup identities to unblock.
app_id String Yes The app the blacklist belongs to.
reference String Yes Your id for this request. Echoed back in the response.

Preconditions

Requirement Why
"Signup Management" permission Needed to manage whitelist and blacklist.

👉 This feature is limited to apps created with the nandbox app builder.

Response

removeFromBlacklist_ack

Field Type Returned Description
method String Yes "removeFromBlacklist_ack"
signups Array of Signup Yes The signups that were removed from the blacklist.
app_id String Yes Echoed from the request.
reference String Optional Echoed from the request.

SDKs

SDK Call Callback
Java api.deleteBlackList(users, appId, reference); onDeleteBlackList(BlackList blackList)
JavaScript api.deleteBlackList(users, appId, reference); onDeleteBlackList(blackList)
Python napi.delete_black_list(users=users, app_id=app_id, reference=reference) on_remove_black_list(self, black_list)

Example

Request

{
  "method": "removeFromBlacklist",
  "app_id": "90090684293000559",
  "reference": 111111148,
  "signups": ["[email protected]"]
}

List<String> users = new ArrayList<>();
users.add("[email protected]");
api.deleteBlackList(users, "90090684293000559", "111111148");

let users = ["[email protected]"];
api.deleteBlackList(users, "90090684293000559", "111111148");

users = ["[email protected]"]
napi.delete_black_list(users=users, app_id="90090684293000559", reference="111111148")