Removes blacklist patterns, so identities that were blocked only by those rules can sign up again.

💡 The acknowledgement arrives as removeBlacklistPatterns_ack and is delivered to the pattern callback, not the blacklist-user callback.

Request

method is "removeBlacklistPatterns".

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 blacklist 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

removeBlacklistPatterns_ack

Field Type Returned Description
method String Yes "removeBlacklistPatterns_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.deleteBlackListPatterns(chatId, patterns, appId, reference); onBlackListPattern(Pattern blackListPattern)
JavaScript api.deleteBlackListPatterns(chatId, patterns, appId, reference); onBlackListPattern(pattern)
Python napi.delete_black_list_patterns(chat_id=chat_id, data=patterns, app_id=app_id, reference=reference) on_black_list_pattern(self, black_list_pattern)

Example

Request

{
  "method": "removeBlacklistPatterns",
  "chat_id": "90090684293000559",
  "app_id": "90090684293000559",
  "reference": 111111148,
  "patterns": [".*@fake.com"]
}

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

let patterns = [".*@fake.com"];
api.deleteBlackListPatterns("90090684293000559", patterns, "90090684293000559", "111111148");

patterns = [".*@fake.com"]
napi.delete_black_list_patterns(
    chat_id="90090684293000559",
    data=patterns,
    app_id="90090684293000559",
    reference="111111148",
)

Response