...
| Code Block |
|---|
GET https://api.smartsender.eucom/v1/contacts/{contactId}/notes |
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"cursor": {
"page": 1,
Cursor,
"pages": 1
},
"collection": [
{
"id": 1,
"content": "Interested",
"user": {
"id": "1",
"email": "serdiuk@smartsender.eu",
"phone": "380950001111",
"photo": "https:\/\/accounts.smartsender.eu\/storage\/avatars\/04TYTXWoSxMM2q5ON1Pd8RjiUYe31Kjj8c5UM7rg.picture", "lastName": "Serdiuk",
"fullName": "Oleksandr Serdiuk",
"firstName": "Oleksandr",
"locale": "ru",
"subscribed": 1,
"timezone": "Europe\/Kiev",
"alertsEnabled": true,
"preferredCurrency": "usd",
"createdAt": "2019-08-02 15:25:26"
},
"createdAt": "2019-08-22 17:13:09"
}
Note[]
} |
Описание ответа:
Название | Описание |
|---|---|
cursor.page | Запрашиваемая страница |
cursor.pages | Количество страниц с указанным лимитом вывода |
collection.*.id | ID заметки |
collection.*.content | Описание заметки |
collection.*.createdAt | Дата создания заметки |
collection.*.user | Пользователь, создавший заметку |
collection.*.user.id | ID пользователя |
collection.*.user.email | Email пользователя |
collection.*.user.phone | Телефон пользователя |
collection.*.user.photo | Аватар пользователя |
collection.*.user.fullName | Полное имя пользователя |
collection.*.user.firstName | Имя пользователя |
collection.*.user.locale | Язык пользователя |
collection.*.user.subscribed | Подписка на обновление пользователя |
collection.*.user.timezone | Таймзона пользователя |
collection.*.user.alertsEnabled | Статус уведомлений (включено / выключено) |
collection.*.user.preferredCurrency | Предпочитаемый выбор валюты для вывода |
collection.*.user.createdAt | Дата регистрации пользователя |
Объект типа Cursor | |
collection | Массив объектов типа Note |
Создание.
Создание заметки для контакта.
| Code Block |
|---|
POST https://api.smartsender.eucom/v1/contacts/{contactId}/notes |
Основные параметры:
Название | Описание |
|---|---|
text | Описание заметки |
...
В случае успешного ответа получите следующее:
...
Название
...
Описание
...
.id
...
ID заметки
...
content
...
Описание заметки
...
createdAt
...
Дата создания заметки
...
user
...
Пользователь, создавший заметку
...
user.id
...
ID пользователя
...
user.email
...
Email пользователя
...
user.phone
...
Телефон пользователя
...
user.photo
...
Аватар пользователя
...
user.fullName
...
Полное имя пользователя
...
user.firstName
...
Имя пользователя
...
user.locale
...
Язык пользователя
...
user.subscribed
...
Подписка на обновление пользователя
...
user.timezone
...
Таймзона пользователя
...
user.alertsEnabled
...
Статус уведомлений (включено / выключено)
...
user.preferredCurrency
...
Предпочитаемый выбор валюты для вывода
...
user.createdAt
...
объект типа Note.
Обновление.
Позволяет обновить выбранную заметки у контакта.
| Code Block |
|---|
PUT https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId} |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"state": true
} |
Удаление.
Позволяет удалить выбранную заметки у контакта.
| Code Block |
|---|
DELETE https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId} |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"state": true
} |