1. Главная страница
  2. Помощь
  3. Как работать по API с sender-solutions.com
  4. 2. Редактирование подписчика по API

2. Редактирование подписчика по API

2. Редактирование подписчика по API

Метод предназначен для редактирования существующего подписчика в проекте. Данные передаются в формате application/json.

HTTP запрос
  • URL: https://sender-solutions.com/api/subscribers/edit-subscriber/
  • HTTP Метод: POST
  • Content-Type: application/json
Тело запроса (JSON)
{
    "Subscriber": {
        "Id": 23,
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastLame": "Catstone",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        },
        "Birthday": "2002-04-15"
    }
}
Пример запроса с использованием cURL

curl --location 'https://sender-solutions.com/api/subscribers/edit-subscriber/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data-raw '{
    "Subscriber": {
        "Id": 23,
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastLame": "Catstone",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId12345",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        },
        "Birthday": "2002-04-15"
    }
}'
Описание полей
Поле Тип Обязательное Описание
Subscriber.Id boolean Идентификатор подписчика
Subscriber.Base.Id number Идентификатор Базы подписчиков. Обязательно должно быть указано это поле, либо Subscriber.Base.Name. Если передать непустые значения в оба поля, приоритет отдаётся Subscriber.Base.Id
Subscriber.Base.Name string Имя Базы подписчиков. Обязательно должно быть указано это поле, либо Subscriber.Base.Id. Если передать непустые значения в оба поля, приоритет отдаётся Subscriber.Base.Id
Subscriber.IsActive boolean Флаг активности подписчика. По умолчанию false
Subscriber.Email string Email подписчика
Subscriber.FirstName string Имя
Subscriber.LastLame string Фамилия
Subscriber.Gender string Пол подписчика. Возможные значения: "male" для мужского, "female" для женского, ""(пустая строка) для значения "Не указано". По умолчанию "Не указано"
Subscriber.Phone string Номер телефона
Subscriber.Tags array[string] Теги подписчика, массив строк
Subscriber.ClientUserId string ID подписчика в системе клиента
Subscriber.CustomField1 string Свободное поле 1, заполняйте любую информацию по своему усмотрению.
Subscriber.CustomField2 string Свободное поле 2, заполняйте любую информацию по своему усмотрению.
Subscriber.CustomField3 string Свободное поле 3, заполняйте любую информацию по своему усмотрению.
Subscriber.Address.Country string Двухсимвольный код страны (ISO 3166-1 alpha-2)
Subscriber.Address.City string Город
Subscriber.Address.State string | null Регион / штат / область
Subscriber.Address.Zip number Почтовый индекс
Subscriber.Address.Line1 string Основная строка адреса
Subscriber.Address.Line2 string Дополнительная строка адреса
Subscriber.Address.Line3 string | null Дополнительная строка адреса
Subscriber.Birthday string (YYYY-MM-DD) Дата рождения в формате YYYY-MM-DD
Пример успешного ответа. Содержит актуальные данные подписчика (после обновления) в такой же структуре, как и в API запросе.
{
    "success": true,
    "Subscriber": {
        "Id": 23,
        "Base": {
            "Id": 13,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastLame": "Catstone",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": [
            "api",
            "test-user"
        ],
        "ClientUserId": "ClientUserId12345",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": "",
            "Zip": "65000",
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": ""
        },
        "Birthday": "2002-04-15"
    }
}