group_id
parameter or a group external reference via the group_external_ref
attribute.
If both are provided, the request will not be successful.
All date fields included in the body parameters need to be specified as ISO8601-formatted date strings.
Date fields should follow a “YYYY-MM-DD” format.
Header
The authentication token for your request
Body
The id of a group to use for the listing sync operation.Used for:
- searching for an existing listing record to update
- setting group assignment for a newly created listing record
- deleting listings in the group that are not provided in the request body
The external reference of a group to use for the listing sync operation.Used for:
- searching for an existing listing record to update
- setting group assignment for a newly created listing record
- deleting listings in the group that are not provided in the request body
Response
Whether the listing sync operation has been successful.
Errors
Listed below are common errors that may be returned by the endpoint, along with their corresponding status code. Status Code - 400Missing Authorization header
Expired Authorization header bearer token value
Invalid Authorization header bearer token value
Both group id and external ref provided for the listing synchronise operation
No group provided for the listing synchronise operation
Both the number_of_bathrooms and the bathrooms attributes are populated
Authenticated user does not have access to the requested group
No external reference provided for a listing
Date on listing is in an incorrect format
Vacancy is missing unit_type
Listing is missing listing_url
Listing has invalid unit_type
Listing has neither of the bathroom attributes provided
Listing does not have a bathroom attribute and the number of bathrooms is less than 1