This API allows you to remove a subscriber from an existing List in your Juvlon Account.
If a subscriber with the same email address or SubscriberID already exists in your account, then that subscriber gets removed from provided Lists. The API returns a 200.
This API needs to be called using an HTTP Post method with data in JSON format as shown below.
URL: https://api2.juvlon.com/v4/removeFromLists
JSON Parameter –
'{"apiKey":"$apiKey", "email":"$email", "mobile":"$mobile", "subID":"$subID", "listName":"$listName" }';
Arguments
Name | Type | Description | Default |
---|---|---|---|
ApiKey | String | (Mandatory) The apiKey is a unique key generated for your account that authenticates you and helps us to identify your Juvlon account. | |
String | (Mandatory) The email address of your subscriber. | ||
mobile | String | (Mandatory) The mobile number of your subscriber. | |
subID | Int | Optional. If you know subscriberID. subID takes preference over Email and Mobile. | |
listName | String | The name of the existing list into which you would like to add this subscriber. |
Return value
Type | Description | |
---|---|---|
code | The Success or Error code as per the result of executing this API call. Please refer to the section “Possible-Response-Codes” for more details. | |
status | The success or error text corresponding to the returned error code. Please refer to the section “Possible-Response-Codes” for more details. | |
transactionId | A number generated by the API to uniquely identify the current call. Also known as the API_Call_ID. |
Usage / Example(s)
PHP Example Code for Integration
$url = https://api2.juvlon.com/v4/removeFromLists; $data = '{"apiKey":"KEY", "email":"example@abc.com", "mobile":"9890999999", "subID":"1234", "listName":"listName1,listName2" }'; $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); $res1 = curl_exec($ch); curl_close($ch);
Success-Response
HTTP/1.1 { "code":"200", "status":"Success:Subscriber added successfully", "transactionid":"2381" }
Error-Response
HTTP/1.1 { "code":"446", "status":"Error:Invalid API key" }
Possible-Response-Codes
200 Success:Subscriber added successfully 201 Success:Subscriber Exists & Request accepted 401 Error:Invalid Method 402 Error:Unauthorized/Empty Key 403 Error:Unauthorized/Invalid Key 404 Error:API call limit exceeded 405 Error:Your Juvlon account is expired 406 Error:API Not Found 407 Error:API Version Not Found 408 Error:API Function not found 440 Error:Subscriber credit not available 441 Error:Invalid List Name 442 Error:Subscriber Already Exist 443 Error:INACTIVE Subscriber 444 Error:Can not add more than 10 Subscribers in Test List 501 Error:Severe server error. Try later