---
title: "Suspend an entity"
method: POST
path: "/v3/labels/entities/{id}/suspend"
tags: ["Entities"]
---

# Suspend an entity

`POST /v3/labels/entities/{id}/suspend`

Freeze only. The entity's member sessions stop on their next request with
`entity-suspended`, member writes are refused, and an entity hold keeps every
row the entity owns at its published content on every full publish. The last
published state stays live; nothing is reverted or hidden by the suspension
itself. The reason is internal and never returned to the entity's members.
Platform session only. Suspending an already suspended entity answers
`suspensionOutcome: unchanged`.

## Path parameters

- `id` string, required

## Request body

- object
  - `reason` string, required

## Response `200`

Suspension state after the request.

- object
  - `data` EntitySuspensionResult, required
    - `id` string, required
    - `suspended` boolean, required
    - `suspendedAt` string, date-time, nullable, required
    - `suspendedBy` object, nullable, required
      - `kind` 'platform-admin', required
      - `id` string, required
    - `reason` string, nullable, required — Internal; platform sessions only.
    - `suspensionOutcome` 'suspended' | 'resumed' | 'unchanged', required
    - `hold` LabelHoldSummary — What a draft read shows on a held row.
      - `id` string, uuid, required
      - `kind` 'quarantine' | 'entity-hold', required
      - `reason` string, required
      - `since` string, date-time, required
  - `meta` PaginationMeta, required
    - `total` integer — Exact total count when the endpoint provides one.
    - `hasMore` boolean — Indicates whether another page exists beyond the current page.
    - `offset` integer
    - `limit` integer — Echoed page size after endpoint-side clamping.
    - `outcome` 'disabled' | 'removed' — On a toolbox config DELETE, what happened to the row.
    - `origin` 'baseline' | 'override' — On a toolbox config DELETE, whether the row is shipped in YAML (`baseline`) or was created through the API (`override`).
    - `products` ProductLabels[] — On a curation vault `POST`, `PUT`, or `PATCH`: the products the write touched (the one the vault left and the one it joined) as they are after the write, `governanceMode` included, so the caller applies them instead of re-reading.
      - `id` string, required
      - `chainId` integer, required
      - `entityId` string, required
      - `coBrandEntityIds` string[], required — Additional entities whose logos should be displayed. Product management remains exclusively with entityId.
      - `name` string, required
      - `logo` string, nullable
      - `description` string, nullable
      - `url` string, nullable
      - `portfolioNotice` string, nullable
      - `isDeprecated` boolean, required
      - `deprecationReason` string, nullable
      - `notExplorable` boolean, nullable, required — Curator listing flag. `null` leaves the decision to platform overrides and deprecation, `true` hides the vault(s) from discovery, `false` keeps a deprecated vault listed.
      - `governanceMode` 'governed' | 'ungoverned' | 'unknown', required — Derived by the server from the on-chain governor of member vaults; clients cannot set it. Products are created as `unknown`. Every vault assignment recomputes the mode over the resulting member set and rejects sets that mix governed and ungoverned vaults. Layer 2 adopts `governed` or `ungoverned` for an `unknown` product once its membership verifies against chain state. Entity members cannot update or delete an `ungoverned` product or its vaults after the initial assignment.
      - `resolved` ResolvedProductLabels, required — Read-time entity fallbacks for display. Derived, never stored.
        - `entityName` string, nullable, required
        - `url` string, nullable, required — Product url, falling back to the owning entity url.
        - `logo` string, nullable, required — Product logo, falling back to the owning entity logo.
      - `anyExplorableLend` boolean, required — True when at least one member vault is lend-discoverable per the materialized visibility verdicts. Live chain state (e.g. borrowability) is deliberately excluded.
      - `anyExplorableBorrow` boolean, required — True when at least one member vault is borrow-discoverable per the materialized visibility verdicts. Live chain state (e.g. borrowability) is deliberately excluded.
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `hold` LabelHoldSummary — What a draft read shows on a held row.
        - `id` string, uuid, required
        - `kind` 'quarantine' | 'entity-hold', required
        - `reason` string, required
        - `since` string, date-time, required
    - `timestamp` string, date-time, required
    - `chainId` string — Comma-separated chain IDs for multi-chain responses.
    - `degradedProviders` string[] — Live providers whose data is incomplete in this response.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `422` — Validation error
- `500` — Internal server error
- `503` — Service unavailable

## Changes

- **2026-09-11** `fd7c881fd90a` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/euler/apis/euler-data-api-v3/changes/v3/labels/entities/:id/suspend/post.md)

---

[API](https://skmtc.dev/euler/apis/euler-data-api-v3.md) · [All operations](https://skmtc.dev/euler/apis/euler-data-api-v3/llms.txt) · [OpenAPI document](https://skmtc.dev/euler/apis/euler-data-api-v3/revisions/fd7c881fd90a?raw)