Contact Notes API - ua

За допомогою цього API можна переглядати, редагувати, створювати та видаляти нотатки для вибраного контакту.

Читання.

Отримання списку створених нотаток для контакту.

GET https://api.smartsender.com/v1/contacts/{contactId}/notes

Основні параметри:

Назва	Опис	Валідація

Назва	Опис	Валідація
page	Запрошувана сторінка	Мінімальне значення 1
limitation	Кількість даних для виводу на сторінці	Мінімальне значення 1, максимальне 20

У разі успішної відповіді отримаєте таке:

{
    "cursor": Cursor,
    "collection": Note[]
}

Опис відповіді:

Назва	Опис

Назва	Опис
cursor	Об'єкт типу Cursor
collection	Масив об'єктів типу Note

Створeння.

Створення нотатки для контакту.

POST https://api.smartsender.com/v1/contacts/{contactId}/notes

Основні параметри:

Назва	Опис

Назва	Опис
text	Опис нотатки

У разі успішної відповіді отримайте об'єкт типу Note

Оновлення.

Дозволяє оновити вибрану нотатку в контакті.

PUT https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId}

У разі успішної відповіді отримаєте таке:

{
    "state": true
}

Видалення.

Дозволяє видалити вибрану нотатку у контакту.

DELETE https://api.smartsender.com/v1/contacts/{contactId}/notes/{noteId}

У разі успішної відповіді отримаєте таке:

{
    "state": true
}

Documentation