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 number Ідентифікатор підписника
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"
    }
}