С помощью данного API вы можете просматривать, добавлять, редактировать и удалять теги в проекте.
Чтение.
Позволяет просмотреть созданные теги в проекте.
| Code Block |
|---|
GET https://api.smartsender.com/v1/tags |
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
term | Строка для поиска |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"cursor": Cursor,
"collection": Tag[]
} |
Описание ответа:
Создание.
Позволяет создать тег в проекте.
| Code Block |
|---|
POST https://api.smartsender.com/v1/tags |
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
name | Название | Уникальный в рамках проекта |
color | Цвет | 6 символов для обозначение HEX |
В случае успешного ответа получите созданный Tag объект.
Обновление.
Позволяет обновить существующий тег.
| Code Block |
|---|
PUT https://api.smartsender.com/v1/tags/{tagId} |
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
name | Название | Уникальный в рамках проекта |
color | Цвет | 6 символов для обозначение HEX |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"state": true
} |
Удаление.
Позволяет удалить существующий тег.
| Code Block |
|---|
DELETE https://api.smartsender.com/v1/tags/{tagId} |
В случае успешного ответа получите следующее:
| Code Block |
|---|
{
"state": true
} |