Empty BlackList

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Blacklist Management >

Empty BlackList

This function purges/empties the blacklist.

 

Request

Method

URL

POST

/smserver-default/sms.EmptyBL

RAW

POST /smserver-default/sms.EmptyBL HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

 {

   "AwhatPermanent" : true,

   "Awhattemporary" : false

 }

]

Explained

Deletes some or all the items in the Blacklist.

 

Payload:

A single element JSON array containing an object with 2 properties:

AwhatPermanent: true or false, specifies whether you want to delete Permanent blacklist items or not

AwhatTemporary: true or false, specifies whether you want to delete Temporary blacklist items or not

 

When both are set to true, the entire blacklist will be emptied.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

{

       "Result" : 1

   }

],"id":772674711}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

ResultMsg: a friendly message (success or error message) explaining what happened