Archive a unit
Archives a unit: it leaves lists, search and pickers while every record it owns is kept and it stays readable by id. Reversible via the unarchive action, and NOT a deletion. Idempotent: archiving an already-archived unit returns its current state.
Archives a unit: it leaves lists, search and pickers while every record it owns is kept and it stays readable by id. Reversible via the unarchive action, and NOT a deletion. Idempotent: archiving an already-archived unit returns its current state.
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Path Parameters
UUIDv7 identifier of the resource.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/units/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "unit", "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811", "unit_type_id": "09feeea8-7692-422e-90f1-4a851084cb1a", "name": "string", "status": "available", "floor": "string", "building": "string", "list_price_minor": 0, "currency": "str", "attributes": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "archived_at": "2019-08-24T14:15:22Z", "rateable_value_minor": 0 }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "not_found", "message": "Resource not found." }}{ "error": { "code": "conflict", "message": "The request conflicts with current resource state." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}