removeWhitelistPatterns

Use this method to remove whitelist patterns.

Field	Type	Required	Description
`method`	String	Yes	`"deleteWhitelistPatterns"`
`app_id`	String	Yes	Unique identifier for App.
`patterns`	Array of String	Yes	List of patterns being removed.
`reference`	String	Optional	Unique identifier for the request.

Preconditions for API Functionality

The following tables outline the preconditions that must be met for the API to function correctly. Failure to meet these conditions may result in errors or unexpected behavior.

Preconditions for API permissions

Before performing signup management messages, ensure the following conditions are met:

Action	Required Permission	Description
Signup Management	`"Signup Management"`	The API must have the `"Signup Management"` permission to manage both whitelist and blacklist settings.

Response

removeWhitelistPatterns_ack

✅ On success, the removeWhiteListPatterns_ack method is returned with an echo of the whitelist patterns object being removed.

Field	Type	Returned	Description
`method`	String	Yes	`"removeWhitelistPatterns_ack"`
`app_id`	String	Yes	Unique identifier for App.
`data`	Array of patterns	Yes	An array of whitelist patterns.
`reference`	String	Optional	Unique identifier echoed from the request.

Request:

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

}

java

ArrayList<String> pattern = new ArrayList<>();
pattern.add(".*@gmail.com");
api.deleteWhiteListPatterns(incomingMsg.getChat().getId(), pattern);

public void deleteWhiteListPatterns(String chatId, List<String> pattern) {
	DeleteWhiteListPatternsOutMessage deleteWhiteListPatterns = new DeleteWhiteListPatternsOutMessage();
	deleteWhiteListPatterns.setChatId(chatId);
	deleteWhiteListPatterns.setPattern(pattern);
	api.send(deleteWhiteListPatterns);
}

javascript

let pattern = [];
pattern.push(".*@gmail.com");
api.deleteWhiteListPatterns(incomingMsg.chat.id, pattern);

python

Response

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

}