Метод deleteTag

Метод для удаления пользовательской метки.

Внимание: удаляется и сама метка, и связь этой метки с подписчиками!

Принцип использования

Синтаксис и URL для вызова метода
deleteTag (int id)
https://api.unisender.com/ru/api/deleteTag?format=json&api_key=KEY&id=ID

Аргументы
api_key * Ключ доступа к API
id * Код одной из меток, возвращённый методом getTags.

Возвращаемое значение
Пустой объект в случае успеха. Если возникнут ошибки или предупреждения, они будут возвращены стандартным способом.

Примеры возвращаемых значений:

{"result":{}}
{"error":"tag not found","code":"unspecified","result":""}

 

Примеры на PHP

Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Используйте SSL-соединение с UniSender. Подробнее о методах соединения здесь.

Пример с использованием POST-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxx";

// ID поля подстановки, которое надо удалить
$tag_id = "1092208";

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'id' => $tag_id
);

// Устанавливаем соединение
$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_URL,
            'https://api.unisender.com/ru/api/deleteTag?format=json');
$result = curl_exec($ch);

if ($result) {
  // Раскодируем ответ API-сервера
  $jsonObj = json_decode($result);

  if(null===$jsonObj) {
    // Ошибка в полученном ответе
    echo "Invalid JSON";

  }
  elseif(!empty($jsonObj->error)) {
    // Ошибка удаления поля
    echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";

  } else {
    // Выводим коды и названия всех имеющихся списков
    // Метка была успешно удалена
    echo "Tag #$tag_id was successfully deleted";
  }
} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}
Пример с использованием GET-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxxxxx";

// ID поля подстановки, которое надо удалить
$tag_id = "1092208";

// Создаём GET-запрос
$api_url = "https://api.unisender.com/ru/api/deleteTag?format=json".
           "&api_key=$api_key&id=$tag_id";

// Делаем запрос на API-сервер
$result = file_get_contents($api_url);

if ($result) {
  // Раскодируем ответ API-сервера
  $jsonObj = json_decode($result);

  if(null===$jsonObj) {
    // Ошибка в полученном ответе
    echo "Invalid JSON";

  }
  elseif(!empty($jsonObj->error)) {
    // Ошибка удаления метки
    echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";

  } else {
    // Метка была успешно удалена
    echo "Tag #$tag_id was successfully deleted";
  }

} else {
  // Ошибка соединения с API-сервером
  echo "API access error";
}