Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Позволяет просмотреть созданные теги в проекте.

Code Block
GET https://api.smartsender.eu/v1/tags

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

Название

Описание

Валидация

page

Запрашиваемая страница

Минимальное значение 1

limitation

Количество данных для вывода на странице

Минимальное значение 1, максимальное 20

...

В случае успешного ответа получите следующее:

Code Block
{
    "cursor": {
        "page": 1,
        "pages": 3
    },
    "collection": [
        {
            "id": 1,
            "name": "Demo",
            "color": "#812903"
        },
        {
            "id": 3,
            "name": "Demo 1",
            "color": "#fa8123"
        },
        {
            "id": 4,
            "name": "Demo 2",
            "color": "#e3e3e3"
        },
        {
            "id": 5,
            "name": "Demo 3",
            "color": "#fa8123"
        }
    ]
}

Описание ответа:

Название

Описание

cursor.page

Запрашиваемая страница

cursor.pages

Количество страниц с указанным лимитом вывода

collection.*.id

ID тега

collection.*.name

Название тега

collection.*.color

Hex цвет тега

...

Позволяет создать тег в проекте.

Code Block
POST https://api.smartsender.eu/v1/tags

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

Название

Описание

Валидация

name

Название

Уникальный в рамках проекта

color

Цвет

6 символов для обозначение HEX

...

В случае успешного ответа получите следующее:

Code Block
{
    "id": 10999,
    "name": "test",
    "color": "#ab29a"
}

Обновление.

Позволяет обновить существующий тег.

Code Block
PUT https://api.smartsender.eu/v1/tags/{tagId}

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

Название

Описание

Валидация

name

Название

Уникальный в рамках проекта

color

Цвет

6 символов для обозначение HEX

...

В случае успешного ответа получите следующее:

Code Block
{
    "state": true
}

Удаление.

Позволяет удалить существующий тег.

Code Block
DELETE https://api.smartsender.eu/v1/tags/{tagId}

В случае успешного ответа получите следующее:

Code Block
{
    "state": true
}