Amenities

Create amenity

POST
Create an amenity for an integration.

Request

This endpoint expects an object.
integration_id
stringRequired
property_id
stringOptional
The Propexo unique identifier for the property
unit_id
stringOptional
The Propexo unique identifier for the unit
name
stringOptional
The name associated with the amenity
description
stringOptional
Description of the amenity
is_published
booleanOptional
Whether the amenity should be published

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/amenities \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "integration_id": "integration_id"
6}'
200
Successful
1{
2 "job_id": "job_id",
3 "data": {}
4}