Blacklists
All endpoints related to Blacklists
Supported Endpoints
getAllBlacklists()
: Returns a list of all the blacklists created.getBlacklist(id)
: Retrieves a blacklist by the entered ID.createBlacklist(type, data, description)
: Creates a blacklist and returns the created blacklist.updateBlacklist(id, type, data, description)
: Updates a blacklist by the entered ID.deleteBlacklist(id)
: Deletes a blacklist by the entered ID.
getAllBlacklists()
getAllBlacklists()
getBlacklist()
getBlacklist()
Type | Required | Description | |
---|---|---|---|
| string | ✔️ | ID of a Blacklist |
createBlacklist()
createBlacklist()
Parameters | Type | Required | Description |
---|---|---|---|
| string | ✔️ | can be one of the following - "email", "ip", "country" |
| string | ✔️ | Depending on the type you chose, you can enter an IP address, email address, or country code here. |
| string | ✔️ | A description that will help you remember why this Blacklist rule was created. |
updateBlacklist()
updateBlacklist()
Parameters | Type | Required | Description |
---|---|---|---|
| string | ✔️ | ID of the Blacklist you want to update |
| string | ✔️ | Can be one of the following - "email", "ip", "country" |
| string | ✔️ | Depending on the type you chose, you can enter an IP address, email address, or country code here. |
| string | ✔️ | A description that will help you remember why this Blacklist rule was created. |
deleteBlacklist()
deleteBlacklist()
Parameters | Type | Required | Description |
---|---|---|---|
| string | ✔️ | ID of a Blacklist |
Last updated