Through this API you can create a Location. If you do not use Brand than leave the Brand field blank.

Request

Name Method Description
/v1/createlocation POST This end-point will create a location under a brand for an Agency.

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 the Brand in our system.
client_brand_id string required/optional This is the unique identifier of the Brand in your system.
client_location_id string required This is the unique identifier of the Location in your system.
business_location_name string required The "Business Name" field should contain the business name only, for example "Jersey Mike's" without any location/store specific identifiers. The "Store ID" field should contain the location/store specific identifier, for example "Carmel Valley" or "Fashion Mall" or a code you use to identify stores such as "EF" or "2015".
store_id string optional If you are creating multiple locations for the same Brand, populate this field with a unique store ID. If you leave this field blank the system will default it to the name of the city.
store_phone string required This is the business store phone number.
address string required This is the business location address.
city string required This is the city name.
state string required This is the 2 character abbrevation code for state. For e.g. AZ, CA etc..
country string required This is the 2 character abbrevation code for country. For e.g. US, AU etc..
zip string required This is the zip code.
location_url string optional This is the location url.
first_name string optional This is the location user first name. If you do not enter any value for first name then default value would be #ORM.
last_name string optional This is the location user last name. If you do not enter any value for last name then default value would be #ORM.
title string optional This is the position of the location user. For e.g. Sales Manager, Executive etc..
email string optional This will be the email address used to login to the platform for this user/location. This is optional but adding a user will allow you to provide a manager or employee their own login credentials as well as automatically set them up to receive daily review alerts, and a monthly activity report.
phone string optional This is the admin phone number.
locationStatus string optional This feature accepts two values: enable | disable and enable is the default value.
This feature is designed to allow you time to get all of the necessary information entered (review site login credentials and URLs) before providing the business any reports or access to the platform. You will still be charged for this location and can activate it at any time by going to the Inactive Locations section of the Settings menu.
googleQA_note text optional If you are using the Response Scribe service, you can provide notes to help the person responding to your questions. It’s always helpful to include information like specific terms in your industry, how you like to address customers, or anything else that could help the response scribe understand how your answers should look.
location_note text optional If you are using the Response Scribe service, you can provide notes to help the person responding to your reviews. It’s always helpful to include information like specific terms in your industry, how you like to address customers, or anything else that could help the response scribe understand how your responses should look.
escalate_email string optional Here you can provide the email address that this location’s escalated review responses should be sent to. If this field is not completed, the escalate emails will go to the brand account owner’s email address. You can add up to three emails seperated by semicolon (;);
positive_rate string optional This feature allows you to auto-populate your review response field with a custom close. You are provided two options which will allow you to craft a close that fits the client's level of satisfaction e.g., "Best, John Doe - General Manager"
negative_rate string optional This feature allows you to auto-populate your review response field with a custom close. You are provided two options which will allow you to craft a close that fits the client's level of satisfaction e.g., "Please contact me at 888-663-8926 / johndoe@ABCPlumbing.com so I can help resolve this issue."

Sample Request

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

Response Data

This section outlines the standard response values from a create location api

Sample Response

{
  "status": "success",
  "message": "Location has been created successfully.",
  "location_id": "SAU1487315619",
  "client_location_id": "1",
  "location_name": "Test Location"
}