Skip to main content
POST
Property boards archive

Authorizations

x-api-key
string
header
required

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

Path Parameters

propertyId
string
required

Body

application/json
reason
enum<string>
required
Available options:
sold,
moved_agent,
self_managing

Response

Success

propertyId
string
required
address
string
required
history
string
required
repairs
required
inspections
required
lastLandlord
object | null
required
archivedAt
string
required
archivedLabel
string
required
reason
enum<string> | null
required
Available options:
sold,
moved_agent,
self_managing
reasonLabel
string | null
required
files
required
filesLabel
string
required