removeWhitelistPatterns

Removes whitelist patterns, so identities that only matched through those rules can no longer sign up.

💡 The request takes plain pattern strings, but the acknowledgement returns pattern objects under data.

Request

method is "removeWhitelistPatterns".

Field	Type	Required	Description
`patterns`	Array of String	Yes	The pattern strings to remove.
`chat_id`	String	Yes	The bot's chat id.
`app_id`	String	Yes	The app the whitelist belongs to.
`reference`	String	Optional	Your id for this request. Echoed back in the response.

Preconditions

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

Response

removeWhitelistPatterns_ack

Field	Type	Returned	Description
`method`	String	Yes	`"removeWhitelistPatterns_ack"`
`data`	Array of Pattern	Yes	The patterns that were removed.
`app_id`	String	Yes	Echoed from the request.
`reference`	String	Optional	Echoed from the request.

SDKs

SDK	Call	Callback
Java	`api.deleteWhiteListPatterns(chatId, patterns, appId, reference);`	`onWhiteListPattern(Pattern pattern)`
JavaScript	`api.deleteWhiteListPatterns(chatId, patterns, appId, reference);`	`onWhiteListPattern(pattern)`
Python	`napi.delete_white_list_patterns(chat_id=chat_id, data=patterns, app_id=app_id, reference=reference)`	`on_white_list_pattern(self, white_list_pattern)`

Example

Request

json
{
  "method": "removeWhitelistPatterns",
  "chat_id": "90090684293000559",
  "app_id": "90090684293000559",
  "reference": 111111148,
  "patterns": [".*@gmail.com"]
}

java
List<String> patterns = new ArrayList<>();
patterns.add(".*@gmail.com");
api.deleteWhiteListPatterns("90090684293000559", patterns, "90090684293000559", "111111148");

javascript
let patterns = [".*@gmail.com"];
api.deleteWhiteListPatterns("90090684293000559", patterns, "90090684293000559", "111111148");

python
patterns = [".*@gmail.com"]
napi.delete_white_list_patterns(
    chat_id="90090684293000559",
    data=patterns,
    app_id="90090684293000559",
    reference="111111148",
)

Response

json
{
  "method": "removeWhitelistPatterns_ack",
  "app_id": "90090684293000559",
  "reference": 111111148,
  "data": [
    { "pattern": ".*@gmail.com" }
  ]
}