REST API > Edit Brand

Through this endpoint, you can edit a Brand.

Request

Name Method Description
/v1/editbrand POST This endpoint can be used to edit a brand on the Online Review Manager platform.

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 id of a brand in our system. The brand id can be sourced from the “Brand - Get” endpoint.
client_brand_id string required/optional This is unique identifier of the brand in your system. This value can be found in the brand sign-up form.
brand_name string optional This is the brand name.
address string optional This is the brand address.
city string optional This is the city name.
state string optional 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 optional This is the zip code.
industry_id integer optional This is the unique industry id. Must be selected from the following list. Click here to see a list of valid Industry Codes.
email string optional This is the brand's primary contact's email.
password string optional This is the password. (Minimum 6 character password required)
first_name string optional This is the brand's primary contact's first name.
last_name string optional This is the brand's primary contact's last name.
title string optional This is the brand's primary contact's title. For e.g. Sales Manager, Executive etc.
phone string optional This is the brand's primary contact's 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 the Customer Satisfaction filter is enabled, the business will be able to issue their customer's an email where they are asked if their expectations were met. Please send one of the following (N => For Off, Y => For On). The default will be 'N'.
business_listing string optional This is a premium service with an added fee of $10/location/month for Listings Lite and $15/location/month for Listings Voice Ready. There is a 12-month commitment. Please reach out to your account rep with any questions.
Please send one of the following: ('Listings Lite', 'Listings Voice Ready').
customer_surveys string optional This is a premium service that allows you to create custom surveys and send them out to your customers. Please note there is an added monthly fee of $25/location. Please reach out to your account rep with any questions.
Please send one of the following: (N => For Off, Y => For On). The default will be 'N'.

Sample Request

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

Response Data

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

Sample Success Message:

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