Through this API you can request reviews by sending the store email and/or SMS text template to given receiver.

Request

Name Method Description
/v1/requestreviews GET This end-point will send the email and/or SMS text template to given receiver.

Please be aware that important laws and regulations (such as the Telephone Consumer Protection Act) govern the use of texting. You are responsible for complying with those laws.

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to you when your Agency was created.
brand_id integer required/optional This is the unique identifier of a Brand in our system. It was automatically created when you created the Brand. If you have created the identical client_location_id for another location under your agency then this parameter becomes "required".
client_brand_id string required/optional This is the unique identifier of a Brand in your system.
location_id integer required/optional This is the unique identifier of the Location in our system.
client_location_id integer required/optional This is the unique identifier of the Location in your system.
email string required/optional This is the email address of the recipient. If provided, an email will be sent.
phone string required/optional This is the mobile number of the recipient. If provided, a SMS text message will be sent.
sender_name string required/optional This is the review request sender name.
customer_name string required/optional This is the customer_name who will get the SMS & Emails.

Sample Request

GET : https://api.online-review-manager.com/v1/requestreviews

Response Data

This section outlines the standard response values from the request reviews api

Sample Response

{
  "status": "success",
  "message": "Email has been sent successfully."
}