Метод createField | Интеграция c UniSender по API

Метод createField

Метод для создания нового пользовательского поля, значение которого может быть задано для каждого адресата и его потом можно будет подставлять в письмо.

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

Синтаксис и URL для вызова метода
createField (string name, string type)
https://api.unisender.com/ru/api/createField?format=json&api_key=KEY&name=NAME&type=TYPE
Аргументы
api_key * Ключ доступа к API.
name * Переменная для подстановки. Должно быть уникальным с учётом регистра. Также не рекомендуется создавать поле с именем, совпадающим с одним из имён стандартных полей (tags, email, phone, email_status, phone_status и пр.) - будет некорректно работать метод importContacts.

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

type * Тип поля. Возможные варианты:

  • string - строка;
  • text - одна или несколько строк;
  • number - целое число или число с десятичной точкой;
  • date - дата (поддерживается формат ДД.ММ.ГГГГ, ДД-ММ-ГГГГ, ГГГГ.ММ.ДД, ГГГГ-ММ-ДД);
  • bool - 1/0, да/нет.

Тип поля имеет значение только для веб-интерфейса, элементы управления подстраиваются под возможные значения. Хранятся значения разных типов одинаково, в виде текста.

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

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

{"result":{"id":1092208}}

Вы нашли ответ?

0
1