{ "opencollection": "1.0.0", "info": { "name": "RentCheck REST Account Settings Units API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Units", "type": "folder" }, "items": [ { "info": { "name": "Merge two properties", "type": "http" }, "http": { "method": "PUT", "url": "https://prod-public-api.getrentcheck.com/v1/properties/:propertyId/merge/:targetPropertyId", "params": [ { "name": "propertyId", "value": "", "type": "path", "description": "Origin property ID (the one being merged away)." }, { "name": "targetPropertyId", "value": "", "type": "path", "description": "Target property ID (the one that will be kept)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Merges the origin property (`propertyId`) into the target property (`targetPropertyId`). The\norigin is soft-deleted and its occupancies / residents are re-parented to the target. When\n`transfer_rooms` is `true`, the origin's room configuration is merged onto the target.\n" }, { "info": { "name": "Create a unit", "type": "http" }, "http": { "method": "POST", "url": "https://prod-public-api.getrentcheck.com/v1/units", "body": { "type": "json", "data": "{}" } }, "docs": "This resource allows you to create a Unit. Units are single properties that can be occupied by one or more residents." }, { "info": { "name": "Delete units", "type": "http" }, "http": { "method": "DELETE", "url": "https://prod-public-api.getrentcheck.com/v1/units", "params": [ { "name": "id[]", "value": "", "type": "query", "description": "The ids of the units to be deleted. Repeat the parameter to send\nmultiple values (e.g. `?id[]=abc&id[]=def`). The query string must\ncontain `id[]`, and a missing array\nsurfaces as a 500. Individual entries are not validated; ids the\ncaller cannot access are silently skipped.\n" } ] }, "docs": "This resource allows you to delete multiple units at once." }, { "info": { "name": "Get a unit by ID", "type": "http" }, "http": { "method": "GET", "url": "https://prod-public-api.getrentcheck.com/v1/units/:unitId", "params": [ { "name": "unitId", "value": "", "type": "path", "description": "Unit ID" } ] }, "docs": "Get a unit by ID" }, { "info": { "name": "Update a unit", "type": "http" }, "http": { "method": "PUT", "url": "https://prod-public-api.getrentcheck.com/v1/units/:unitId", "params": [ { "name": "unitId", "value": "", "type": "path", "description": "Unit ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update parameters of a unit" }, { "info": { "name": "Create a property (unit) from a Zapier trigger", "type": "http" }, "http": { "method": "POST", "url": "https://prod-public-api.getrentcheck.com/v1/zapier/properties", "params": [ { "name": "orgId", "value": "", "type": "query", "description": "Optional organization id override. Only used when the caller's\nauth token does not already carry `orgId`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Zapier-flavoured entry point for the v1 unit create flow. The Zapier\nrequest body carries a flat property payload; `full_bathrooms` /\n`half_bathrooms` are derived from the single `bathrooms` value, the\nregion name is resolved from the state, and the request is delegated to\nthe v1 unit create flow. The `orgId` is taken from the caller's decoded\nauth token, falling back to the `orgId` query parameter when the token\nhas none.\n" } ] } ], "bundled": true }