json

Описание метода

Осуществляется с помощью POST-запроса. Название операции и набор принимаемых полей настраиваются в системе Майндбокс. Подробней про вызов метода можно прочитать здесь.

Универсальная операция
POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}&deviceUUID={уникальный идентификатор устройства}

Accept: application/json
Content-Type: application/json
Authorization: SecretKey {Секретный ключ, обязательность уточнить у менеджера}

{
  "customer": {
    "ids": {
      "<Идентификатор>": "<Значение идентификатора>",
    },
    "lastName": "<Фамилия клиента>",
    "firstName": "<Имя клиента>",
    "middleName": "<Отчество клиента>",
    "mobilePhone": "<Мобильный телефон клиента>",
    "email": "<Емэйл клиента>",
    "password": "<Пароль>",
    "area": {
      "ids": {
        "externalId": "<Идентификатор региона клиента>"
      }
    },
    "customFields": {
      "<Дополнительное поле>": "<Значение дополнительного поля>",
      "<Дополнительное поле со множеством значений>": [
      "<Значение дополнительного поля>",
      "<Значение дополнительного поля>"
      ],
    },
    "subscriptions": [
      {
        "pointOfContact": "<Канал коммуникации Email/SMS/тд>",
        "topic": "<Тематика рассылок>",
      }
    ]
  }
}

Примеры операций

Code
POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=registration

Accept: application/json
Content-Type: application/json
Authorization: SecretKey D061p764m85bklq

{
  "customer": {
    "ids": {
      "bitrixId": "346257"
    },
    "mobilePhone": 79374134389,
    "fullName": "Петров Иван",
    "email": "test@mindbox.ru",
    "password": "Qwerty",
    "customFields": {
      "city": "Mосква",
      "b2b": true,
      "childrenNames": [
        "Маша",
        "Петя"
      ]
    },
    "subscriptions": [
      {
        "pointOfContact": "Sms",
        "topic": "News"
      },
      {
        "pointOfContact": "Email",
        "topic": "Digest"
      }
    ]
  }
}

Ответ

Code
{
  status: "Success"
}