Метод updateField

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

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

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

Аргументы
api_key * Ключ доступа к API
id * ID изменямого поля
name * Название поля. Должно быть уникальным без учёта регистра. Также не рекомендуется создавать поле с именем, совпадающим с одним из имён стандартных полей (tags, email, phone, email_status, phone_status и пр.) - будет некорректно работать метод importContacts.
public_name

Название поля. Название в кабинете для поля "переменная для подстановки". Если не использовать, то будет проведена автоматическая генерация по полю "name".

Допустимые символы: буквы латинского алфавита, цифры, "_" и "-". Первым символом может быть только буква. Использование пробелов не допускается.

Возвращаемое значение
Объект с полем id, содержащим код изменённого поля.

Пример возвращаемого значения:

{"id":7266567}

 

Примеры на PHP

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

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

// Параметры изменяемого поля
// Если скрипт в кодировке UTF-8, то удалите вызов iconv
$field_name = iconv('cp1251', 'utf-8',"Обновление поля подстановки");
$field_type = "string";
$field_id = "234234";

// Создаём POST-запрос
$POST = array (
  'api_key' => $api_key,
  'name' => $field_name,
  'id' => $field_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/updateField?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 "Field is updated, Field ID is " . $jsonObj->result->id;

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

}

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

// Параметры создания нового поля
// Если скрипт в кодировке UTF-8, то удалите вызов iconv
$field_name = urlencode(iconv('cp1251', 'utf-8',"Обновление поля подстановки"));
$field_id = "3245435";

// Создаём GET-запрос
$api_url = "https://api.unisender.com/ru/api/updatedField?format=json".
           "&api_key=$api_key&name=$field_name&id=$field_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 "New field is creaded, Field ID is " . $jsonObj->result->id;
  }

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