addToBlacklist

Adds signups to the blacklist — the list of identities blocked from registering for your app.

💡 The blacklist always wins. If an identity is on both lists, it is blocked.

Request

method is "addToBlacklist".

Field	Type	Required	Description
`signups`	Array of Signup	Yes	The signups to block. Each carries a `signup_id` and optional `tags`.
`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

addToBlacklist_ack

Field	Type	Returned	Description
`method`	String	Yes	`"addToBlacklist_ack"`
`signups`	Array of Signup	Yes	The signups now on the blacklist, each with its assigned `id`.
`app_id`	String	Yes	Echoed from the request.
`reference`	String	Optional	Echoed from the request.

SDKs

SDK	Call	Callback
Java	`api.addBlackList(users, appId, reference);`	`onBlackList(BlackList blackList)`
JavaScript	`api.addBlackList(users, appId, reference);`	`onBlackList(blackList)`
Python	`napi.add_black_list(users=users, app_id=app_id, reference=reference)`	`on_black_list(self, black_list)`

Example

Request

json
{
  "method": "addToBlacklist",
  "app_id": "90090684293000559",
  "reference": 111111148,
  "signups": [
    {
      "signup_id": "name@example.com",
      "tags": ["4"]
    }
  ]
}

java
List<String> users = new ArrayList<>();
users.add("notAllowed@gmail.com");
api.addBlackList(users, "90090684293000559", "111111148");

javascript
let users = ["notAllowed@gmail.com"];
api.addBlackList(users, "90090684293000559", "111111148");

python
users = ["notAllowed@gmail.com"]
napi.add_black_list(users=users, app_id="90090684293000559", reference="111111148")

Response

json
{
  "method": "addToBlacklist_ack",
  "app_id": "90090684293000559",
  "reference": 111111148,
  "signups": [
    {
      "id": "488",
      "signup_id": "name@example.com",
      "tags": ["4"]
    }
  ]
}