Through this API you can create a Brand in the Online Review Manager table. Remember, if you do not use Brands you do not need to create this API.

Request

Name Method Description
/v1/createbrand POST This end-point will create 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.
client_brand_id string required This is unique identification of a Brand in your system.
brand_name string required This is the name of your preferred business brand name.
address string required This is the brand 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.
industry_id integer required This is the unique identification of industry in Online Review Manager Portal. Click here to see a list of valid Industry Codes.
email string optional This is the company's contact email.
password string optional This is the password.Minimum 6 characters password required
service_plan string required This is the Subscription type. You can send one of them (RS => Review Scribe, RM => Review Monitor, LG => Lead Generator, RN => Review Navigator).
first_name string optional This is the company's contact first name.
last_name string optional This is the company's contact last name.
title string optional This is the company's contact position. For e.g. Sales Manager, Executive etc..
phone string optional This is the company's contact phone number.
url string optional This is the brand url.
Feature Options
cs_filter string optional The Customer Satisfaction filter is a tool to help send unhappy customers to a separate forum to leave a comment, while happy customers are directed to leave a review. If you check this box, the customer will receive an email where they are asked if their expectations were met.
Please send one of them (N => For Off, Y => For On). The default will be 'N'.

Sample Request

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

Response Data

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

Sample Response

{
  "status": "success",
  "message": "Brand has been created successfully.",
  "brand_id": "5001",
  "client_brand_id": 1,
  "brand_name": "Stanley Pest Control",
  "cs_filter": "N"
}