С помощью данного API вы можете просматривать, редактировать, создавать и удалять заметки для выбранного контакта.
Чтение.
Получение списка созданных заметок для контакта.
| Code Block |
|---|
GET https://api.smartsender.com/v1/contacts/{contactId}/notes |
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"cursor": Cursor,
"collection": Note[]
} |
Описание ответа:
Создание.
Создание заметки для контакта.
| Code Block |
|---|
POST https://api.smartsender.com/v1/contacts/{contactId}/notes |
Основные параметры:
Название | Описание |
|---|---|
text | Описание заметки |
В случае успешного ответа получите объект типа 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
} |