Rental assets

Manage rental assets, the profiles that price them and the hours they are available.

Rental assets are the things customers can hire, each priced and scheduled by a rental asset profile. These endpoints list, create, update and delete assets and profiles, cancel and reactivate assets, and read and set each asset’s availability. This area has 14 endpoints, each available in all seven SDKs.

At a glance

Endpoint	Method	Path	What it does
List rental asset availability	GET	/rental_asset_availability	Lists each rental asset with its schedule, one page at a time.
Update rental asset availability	PATCH	/rental_asset_availability	Sets the weekly or custom hours of one or more rental assets.
List rental asset profiles	GET	/rental_asset_profiles	Lists rental asset profiles, one page at a time.
Create a rental asset profile	POST	/rental_asset_profiles	Creates a rental asset profile and returns it under rental_asset_profile.
List rental assets	GET	/rental_assets	Lists rental assets, one page at a time.
Create a rental asset	POST	/rental_assets	Creates a rental asset and returns it under rental_asset.
Retrieve a rental asset profile	GET	/rental_asset_profiles/{rental_asset_profile_id}	Returns one rental asset profile under rental_asset_profile.
Update a rental asset profile	PATCH	/rental_asset_profiles/{rental_asset_profile_id}	Changes a rental asset profile.
Delete a rental asset profile	DELETE	/rental_asset_profiles/{rental_asset_profile_id}	Deletes a rental asset profile.
Update a rental asset	PATCH	/rental_assets/{rental_asset_uuid}	Changes a rental asset and returns it under rental_asset.
Delete a rental asset	DELETE	/rental_assets/{rental_asset_uuid}	Deletes a rental asset and returns no body.
Retrieve a rental asset	GET	/rental_assets/{rental_asset_uuid}	Returns one rental asset under rental_asset.
Cancel a rental asset	POST	/rental_assets/{rental_asset_id}/cancel	Cancels a rental asset, setting its status to inactive.
Reactivate a rental asset	POST	/rental_assets/{rental_asset_id}/reactivate	Reactivates a cancelled rental asset, setting its status to active.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Single records come back under rental_asset or rental_asset_profile. Listings put their records under data.
• rental_asset_uuid and rental_asset_id take the same value. Both are the rental asset’s id; the cancel and reactivate paths name it rental_asset_id.
• Every session of a new profile needs a price. A session with no rental_asset_profile_session_prices is refused with 400.
• Update rental asset availability takes a list and returns no body. It returns 204; read the asset to see the stored hours.
• Cancel sets status to inactive and reactivate sets it to active. Both take an empty object as the body, and cancelling an already cancelled asset is refused.
• Listings page by cursor. Pass limit and the previous page’s pagination.next_cursor as cursor, and stop when has_more is false.