Retrieves the blacklisted signups for your app, one page at a time.

💡 The response method is "blacklist", not getBlacklistUsersResponse. Register your handler on that name.

Request

method is "getBlacklistUsers".

Field Type Required Description
app_id String Yes The app whose blacklist you want.
page_number Number Yes Page to retrieve, starting at 0.
page_size Number Optional Entries per page. Defaults to 50.
reference String Optional Your id for this request. Echoed back in the response.

Preconditions

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

Response

blacklist

Field Type Returned Description
method String Yes "blacklist"
signups Array of Signup Yes The blacklisted signups on this page.
app_id String Yes Echoed from the request.
page_number Number Yes The page this result represents.
eop Boolean Conditional End of pages. true when there is nothing more to fetch. Defaults to false.
reference String Optional Echoed from the request.

SDKs

SDK Call Callback
Java api.getBlackList(appId, reference); onBlackList(BlackList blackList)
JavaScript api.getBlackList(appId, reference); onBlackList(blackList)
Python napi.get_black_list(app_id=app_id, reference=reference) on_black_list(self, black_list)

Example

Request

{
  "method": "getBlacklistUsers",
  "app_id": "90090684293000559",
  "page_number": 0,
  "reference": 111111148
}

api.getBlackList("90090684293000559", "111111148");

api.getBlackList("90090684293000559", "111111148");

napi.get_black_list(app_id="90090684293000559", reference="111111148")

Response