addToWhitelist

Adds signups to the whitelist — the list of identities allowed to register for your app.

💡 If the same identity is on both lists, the blacklist wins.

Request

method is "addToWhitelist".

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

Response

addToWhitelist_ack

Field	Type	Returned	Description
`method`	String	Yes	`"addToWhitelist_ack"`
`signups`	Array of Signup	Yes	The signups now on the whitelist, 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.addWhiteList(users, appId, reference);`	`onWhiteList(WhiteList whiteList)`
JavaScript	`api.addWhiteList(users, appId, reference);`	`onWhiteList(whiteList)`
Python	`napi.add_white_list(users=users, app_id=app_id, reference=reference)`	`on_white_list(self, white_list)`

Example

Request

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

java
List<WhiteListUser> users = new ArrayList<>();
WhiteListUser user = new WhiteListUser();
user.setSignupUser("allowed@gmail.com");
users.add(user);
api.addWhiteList(users, "90090684293000559", "111111148");

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

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

Response

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