Olery Developer Portal logo Olery Developer Portal

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

This route can be used activate properties.

We recommend to make one request for each property.

Output Format

Field Data Types Description
data Array 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
id Fixnum ID of the property
name String Name of the property
activated_at String Timestamp of when the property was activated

Example Output

{
    "message": "Properties were successfully activated.",
    "data": [
        {
            "id": 717775,
            "name": "Hotel Indigo",
            "activated_at": "2018-04-17T12:41:26+00:00"
        }
    ]
}

Parameters

Parameter Parameter Type Data Types Required Description
id path Fixnum true ID of the group
request_connections query Boolean true Indicate if you want Olery to connect the properties to different review sources, should be set to true usually
source_ids query Fixnum false Source IDs of the properties you want to activate
source_urls query String false Encoded URLs of the properties you want to activate

Your group ID will be provided by Olery.

You need to either include source_ids or source_urls in your requests with the necessary information, so we can identify the property.

You can activate multiple properties in one request by comma-separating IDs or URLs.

Response Statuses

Status Code Reason
201 Created
400 Request is not valid
403 You don’t have access to that group
422 Property not found or already active