API ReferenceListings

Update listing

Update a listing for an integration.

Path parameters

listing_idstringRequired
The ID of the resource.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
available_datedatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z
The date the unit is available.
bathroomsstringOptional
The number of bathrooms in the unit
bedroomsstringOptional
The number of bedrooms in the unit
building_namestringOptional
The name of the building
citystringOptional
The city associated with the listing
countrystringOptional
The country associated with the listing
deposit_amount_in_centsintegerOptional
The deposit amount in cents
floorstringOptional
The floor the unit is on
is_availablebooleanOptionalDefaults to false
Whether the unit is available for rent
is_vacantbooleanOptionalDefaults to false
Whether the unit is vacant
lease_termstringOptional
The lease term
notesstringOptional
Additional notes about the unit
rent_amount_in_centsintegerOptional
The rent amount in cents
statestringOptional
The state associated with the listing
street_address_1stringOptional
The first address line associated with the listing
street_address_2stringOptional
The second address line associated with the listing
zipstringOptional
The zip code associated with the listing

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors