Skip to main content

Оновлення сутності (Entity Update API)

Цей API дозволяє оновлювати дані існуючої організації (entity) на платформі Ring. Ви можете змінити назву, опис, сайт, теги, видимість та інші поля.

Ендпоінт​

PATCH /api/entities/update/[id]

  • id — унікальний ідентифікатор сутності (entity)
  • Аутентифікація: потрібна (JWT токен)
  • Ролі: MEMBER, CONFIDENTIAL, ADMIN

Тіло запиту (Request Body)​

Вказуйте лише ті поля, які потрібно оновити:

{
  "name": "Оновлена назва компанії",
  "description": "Оновлений опис",
  "website": "https://newsite.com",
  "tags": ["оновлено", "технології"]
}

Відповідь (Response)​

Успіх (200 OK):

{
  "message": "Сутність успішно оновлена"
}

Можливі помилки:

  • 400 — Некоректний формат або невірні дані
  • 401 — Неавторизовано
  • 403 — Недостатньо прав
  • 404 — Сутність не знайдена
  • 500 — Внутрішня помилка сервера

Приклад коду (TypeScript)​

async function updateEntity(id: string, updates: Partial<Entity>) {
  const response = await fetch(`/api/entities/update/${id}`, {
    method: 'PATCH',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(updates)
  });

  if (!response.ok) {
    const error = await response.json();
    throw new Error(error.error);
  }

  return response.json();
}

Валідація​

  • Оновлюються лише передані поля
  • name: 1-100 символів
  • email: валідний email, якщо вказано
  • website: валідна URL-адреса, якщо вказано
  • visibility: має відповідати ролі користувача

Пов’язані ендпоінти​