Документация · v1

Creodock API

Все операции
PATCHИнтерфейс Creodock

Изменить настройки Telegram для рабочей области

Сохраняет полный permission-aware набор с optimistic version. Недоступные события отклоняются.

PATCHhttps://api.creodock.com/api/v1/organizations/{organizationId}/me/telegram/preferences
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Изменяет существующий ресурс. Передавайте только актуальные данные объекта.
  • Идемпотентность явно не объявлена в контракте: не повторяйте запрос автоматически.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.

Тело запроса

Обязательно для этой операции.

application/json

Схема: TelegramPreferencesInput

ПолеТипОписание
enabledОбязательно
boolean
Поле «enabled» в структуре запроса или ответа.
eventsОбязательно
TelegramEventPreference[]
Поле «events» в структуре запроса или ответа.
quietHoursОбязательно
TelegramQuietHours
Поле «quietHours» в структуре запроса или ответа.
versionОбязательно
integer
Версия объекта для защиты от конфликтующих изменений.Минимум: 1

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Настройки сохранены

application/json

Схема: TelegramPreferences

ПолеТипОписание
enabledОбязательно
boolean
Поле «enabled» в структуре запроса или ответа.
eventsОбязательно
TelegramEventPreference[]
Поле «events» в структуре запроса или ответа.
organizationIdОбязательно
string · uuid
ID рабочей области, которой принадлежит объект.
quietHoursОбязательно
TelegramQuietHours
Поле «quietHours» в структуре запроса или ответа.
versionОбязательно
integer
Версия объекта для защиты от конфликтующих изменений.Минимум: 1
{
  "enabled": true,
  "events": [
    {
      "enabled": true,
      "key": "order.created"
    }
  ],
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "quietHours": {
    "allowUrgent": true,
    "enabled": true,
    "endsAt": "string",
    "startsAt": "string",
    "timezone": "string"
  },
  "version": 1
}
409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}