Empty List
This API is used to empty users in a given list.
API Details
URL Schema:
US IDC:
https://api.netcoresmartech.com/apiv2
Indian IDC:
https://apiin.netcoresmartech.com/apiv2
EU IDC:
https://jsonapi.eu-north-1.eu.netcoresmartech.com/apiv2
Method:
POST
Header:
Key | Value |
---|---|
Content-Type | application/x-www-form-urlencoded |
Parameters:
Parameter | Decription | Data Type | Required | Parameter Type |
---|---|---|---|---|
activity | Activity refers to the action that is being performed through the API, that is, add, delete, update, and so on. Value here: emptylist | String | Yes | Query Parameter |
type | Here type is lists | String | Yes | Query Parameter |
listname | Each list in CEE has a unique name assigned to it to identify. Passing this name is required to let the API know to which list the list is supposed to be emptied. | String | Yes | Query Parameter |
apikey | You can obtain the API key from the CEE panel. Log in to your CEE panel and go to Admin. Enable the API Mode in Account Configuration under Advance details. Now, go to Sub Admin and click Edit on your user name. You can view your API key here. | String | Yes | Query Parameter |
async | Pass the value as 1. | Boolean | No | Query Parameter |
Request:
http://api.netcoresmartech.com/apiv2?activity=emptylist&listname=xx&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&type=lists
http://api.netcoresmartech.com/apiv2?activity=emptylist&listname=xx&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&type=lists&async=1
*Response:
Success :
{
"status": "success",
"details": "List name xx emptied successfully"
}
Success :
{
"status": "success",
"details": "Your request was accepted successfully. It may take a few minutes to process your request. To find out the list count, use the "getalllist" API."
}
Updated about 1 month ago