Skip to content

Quantity.deprecate

Mark this quantity deprecated (staff-only on the server).

Does not run automatically — callers must invoke this explicitly. Optional superseded_by_id records the replacement quantity.

Server: POST /api/foundry/quantities/{id}/deprecate/.

Signature

deprecate(superseded_by_id: str | None=None) -> None

Parameters

Name Type Required Default
superseded_by_id str \| None no None

Fields

Field
superseded_by_id

Return shape

None

Permission

This is a local SDK helper. It does not call the CloudSprite HTTP API.

Usage

quantity.deprecate()