Olery Developer Portal logo Olery Developer Portal

Method Path
DELETE https://agora.olery.com/v3/groups/:id/companies/:ids

This route can be used deactivate properties which have been ative for at least 30 days.

We recommend to make one request for each property.

Output Format

Field Data Types Description
data Hash Details about the properties
message String Message for the user if the request was successful
error String Error message for the user if the request was not successful

Property Fields

In the data key property details are returned.

Field Data Types Description
company_ids Array IDs of the properties

Example Output

{
	"message": "Properties were successfully deactivated.",
	"data": {
		"company_ids": [
			709773
		]
	}
}

Parameters

Parameter Parameter Type Data Types Required Description
group id path Integer true ID of the group
company ids path Integer true IDs of the properties to be deativated

You can deactivate multiple properties in one request by comma-separating IDs.

Response Statuses

Status Code Reason
200 OK
403 You don’t have access to that group
422 Property is not active