Skip to main content
POST
Retire asset

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

assetId
string
required

Body

application/json
requestId
string
required
expectedRevision
required
reason
enum<string>
required
Available options:
replaced,
removed,
condemned,
other
replacedByAssetId
string | null
required

Response

Success

assetId
string
required
propertyId
string | null
required
blockId
string | null
required
installedOn
string | null
required
ageMonths
required
expectedLifeYears
required
replacementCost
object | null
required
installCost
object | null
required
installerContactId
string | null
required
retiredAt
string | null
required
retiredReason
enum<string> | null
required
Available options:
replaced,
removed,
condemned,
other
replacedByAssetId
string | null
required
revision
required
state
enum<string>
required
Available options:
in_service,
on_watch,
replacement_suggested,
retired
triggers
object[]
required
openRepairs
object[]
required
repairsLast12Months
required
spendLast12Months
object
required
spendToDate
object
required
landlordContactId
string | null
required
landlordEmail
string | null
required
proposals
object[]
required
canEdit
boolean
required