REST API > Create Review

Through this endpoint you can create or add a review to a location.

Request

Name Method Description
/v1/createreview POST Through this endpoint you can create or add a review to a location.

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to your agency. This key can be found in your agency settings under the White Label API information tile.
brand_id integer required This is the unique identifier of a Brand in our system. It was automatically created when you created the Brand. The brand id can be found in your account settings under the account information tile.
location_id integer required This is the unique identifier of a Location in our system. It was automatically created when you created the Location. The location id can be found in the brand settings under the location sign-up form.
rating integer required This is the rating or score based on a scale of 1 to 5. Decimal values are not allowed.
comment text optional This is the comment left by the reviewer.
review_site_id integer required This is the review site id, e.g., 1, 2, 3. Please click here to see the list of review sites.
external_id string required This is the unquie identifier of the review in your platform.
first_name string optional First name of the reviewer. If it is empty, then reviewer's name will be "Anonymous".
last_name string optional Last name of the reviewer.
email string optional Email address of the reviewer.
mobile string optional Phone number of the reviewer.

Sample Request

POST : https://api.online-review-manager.com/v1/createreview

Response Data

You will recieve a success or error message. See sample success message below:

Sample Success Message:

{
    "status": "success",
    "message": "The review has been added to your location.",
    "data": {
        "site_id": 24440,
        "fbreview_id": "OPTSPOT001",
        "review_site_id": 81,
        "link": "optspot.com",
        "rate": "5",
        "title": "Test Location",
        "message": "This is a optspot review for testing purpose.",
        "reviewer": "John Doe",
        "ip": "reviewtrackers",
        "type": "reviewtrackers",
        "review_push": "TEST1234567",
        "created_at": "2023-03-10 11:20:34",
        "scraped_at": "2023-03-10 11:20:34",
        "review_date": "2023-03-10 11:20:34",
        "review_hash": "a5a6fe1d4b11e6acf3e03b40830c179c",
        "fbreview_url": "DE1F6FD9-B2C2-4FC8-8D3A-D41C90A3DE9D",
        "updated_at": "2023-03-10 11:20:34",
        "id": 0000000001
    }
}