removeFromBlacklist

Use this method to remove records from blacklist

Field	Type	Required	Description
`method`	String	Yes	"removeFromBlacklist"
`app_id`	String	Yes	Unique identifier for the App to which the user belongs.
`signups`	Array of Signups	Yes	Add an array of signups.
`reference`	String	Yes	A unique reference for the request (used for tracking or logging).

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.

If you add the same user to the blacklist and whitelist, the priority goes to the blacklist.

📱

This feature is limited to apps created using the nandbox app builder.

Response

removeFromBlacklist_ack

✅ On success, the removeFromBlacklist_ack method is returned, including an echo of the signup record.

Field	Type	Returned	Description
`method`	String	Yes	`"removeFromBlacklist_ack` `"`
`app_id`	String	Yes	Unique identifier for App.
`signups`	Array of signup	Yes	Array of Whitelist signup objects
`reference`	String	Optional	Unique identifier echoed from the request.

Example Requests

json
{
    "method": "removeFromBlacklist",
    "app_id": "90090684293000559",
    "signups": ["name@example.com"],
    "reference": 111111148,
}

java

ArrayList<String> users = new ArrayList<>();
users.add("111133");
api.deleteBlackList(incomingMsg.getChat().getId(), users);

public void deleteBlackList(String chatId, List<String> users) {
	DeleteBlackListOutMessage deleteBlackListOutMessage = new DeleteBlackListOutMessage();
	deleteBlackListOutMessage.setChatId(chatId);
	deleteBlackListOutMessage.setUsers(users);
	api.send(deleteBlackListOutMessage);
}

javascript

let users = [];
users.push("111133");

api.deleteBlackList(incomingMsg.chat.id, users);

Response

json
{
    "method": "removeFromBlacklist_ack",
    "app_id": "90090684293000559",
    "signups": [ "name@example.com"  ],
    "reference": 111111148

}