REST API > Request Reviews

Through this endpoint you can trigger a review request to be sent to a customer.

Request

Name Method Description
/v1/requestreviews GET This end-point will send an email and/or SMS text request to the intended recipient.

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 your agency. This key can be found in your agency settings under the White Label API information tile.
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. The brand id can be found in your account settings under the account information tile.
client_brand_id string required/optional This is the unique identifier of a Brand in your system. This value can be found in the brand sign-up form. Client brand Id is required if brand id is not provided.
location_id integer required/optional This is the unique identifier of the Location in our system. This value can be found in the location sign up form. This field is required when the client location ID is not present.
client_location_id integer required/optional This is the unique identifier of the Location in your system. This value can be found in the location sign-up form. This field is required when the location ID is not present.
email string required/optional This is the email address of the recipient. If provided, an email will be sent to this email address.
phone string required/optional This is the mobile number of the recipient. If provided, an SMS text message will be sent to this mobile number.
sender_name string required/optional This is the name of the person that will be identified as the "sender". This name may also be included in the message if the location has selected this option.
customer_name string required/optional This is the recipient's name who will receive the SMS and/or Email.

Sample Request

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

Response Data

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

Sample Success Message:

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