Skip to main content

Archive a property

POST 
/properties/:propertyId/archive

This endpoint will archive a property, it will set the archived_at timestamp to the current time, unless provided in the request body.

If the property is already archived, calling this endpoint will return a 409 Conflict error.

warning

Archiving a property will also archive all associated resources. It should be used to remove a property that is no longer under management.

Request​

Responses​

Property archived successfully