Subscriber status

This method can be applied on your server-side, in order to check the status of a subscriber (subscribed / unsubscribed)

Method: GET

URL: https://api.retargeting.app/v1/subscriber-status

Field Type Required Description
k number or text True The REST API Key can be found into your account Settings -> Integration -> REST API Key, second field.
email email True Email you want to check the status for

Your account status must be in one of the states: PAID, PAYMENT ERROR or ACCOUNT SUSPENDED.

If your account is Inactive or Closed the API call will not work.

The API call will respond with JSON format.

Example

   <?php
   require_once "vendor/autoload.php";

   $apiURL = "https://api.retargeting.app/v1/";
   $apiKey = "MyAPI_REST_Key";

   $client = new GuzzleHttp\Client();

   $statusData = [
       "k" => $apiKey,
       "email" => "email@example.com"
   ];

   $statusRequest = $client->request("GET", $apiURL . "subscriber-status", ["query" => $statusData]);

If the API call succeeds, then the response will be as seen below:

{
    status: "success",
    data: {
        "email": "subscribed"
        "sms": "subscribed"
    }
}

If the API call fails, the response will be as seen below:

{
    status: "error",
    data: "Subscriber not found!"
}