Listings

*Create listing

POST
Create a listing for an integration.

Request

This endpoint expects an object.
unit_id
stringRequired
The Propexo unit id
rent_amount_in_cents
integerRequired
The rent amount in cents
deposit_amount_in_cents
integerRequired
The deposit amount in cents
available_date
stringRequired
The available date
contact_id
stringRequired
The Propexo contact id
is_managed_external
booleanRequired
Whether the listing is managed externally
lease_terms
stringOptional
The lease terms
custom_data
objectOptional
Deprecated: Field is no longer applicable

Response

This endpoint returns an object
job_id
string
The ID of the job created to handle this operation
data
object
Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.
POST
1curl -X POST https://api.propexo.com/v1/listings \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "unit_id": "unit_id",
6 "rent_amount_in_cents": 1,
7 "deposit_amount_in_cents": 1,
8 "available_date": "available_date",
9 "contact_id": "contact_id",
10 "is_managed_external": true
11}'
200
Successful
1{
2 "job_id": "job_id",
3 "data": {}
4}