Description

Creates a new business in the business directory.

General

End Point
https://www.mogl.com/api/v2/venues/add
HTTP Method POST
Requires SSL true
Requires Acting User true (learn more)
Scope(s) None

Path Parameters

Path parameters are ALWAYS required.

None

Request Parameters

Parameters are NOT REQUIRED unless noted otherwise.

name required The name of the business.
owner required The user to associate as the owner of this business.
address.streetName required The street address for this business.
address.postalCode required The postal code for this business.
description required A description of this business.
url The web url for this business.
priceRange The price range for this business. Valid values [$, $$, $$$, $$$$].
menuUrl The menu url for this business.
buzz Any buzz associated with this business. One or two sentences.
noiseLevel The noiselevel to be expected at this business.
ambiance The ambiance to be expected at this business.
knownFor What this business is known for. One or two sententces.
feedbackEmail The email address that will receive feedback responses.
fullPhone The phone number for this business
businessToken A unique identifier for this business
merchantInfo.merchantId The merchant id for the business.
merchantInfo.amexId Comma seperated list of Amex SE numbers for the merchant.
merchantInfo.visa Comma seperated list of VMID/VSID identifiers for the merchant.
merchantInfo.mastercard Comma seperated list of Mastercard identifiers for the merchant.
discount The basic default discount percent for a venue. [Deprecated - Use offers API]
referralPercent The marketing fee that is assessed on the transaction. [Deprecated - Use offers API]
activeFeatures multi Features associated with this business. Note: this must be from the Mogl feature list.
bestDays multi The best nights for this business [MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY].
serves multi The meals this venue servies [BREAKFAST,LUNCH,DINNER].

Response Fields

venue A venue detail object. See venue details

Try It Now

Endpoint
Client Id
(required)
Access Token
(required)
User Token
*(see below -- client_credentials only)
name
(required)
owner
(required)
address.streetName
(required)
address.postalCode
(required)
description
(required)
url
Add
priceRange
Add
menuUrl
Add
buzz
Add
noiseLevel
Add
ambiance
Add
knownFor
Add
feedbackEmail
Add
fullPhone
Add
businessToken
Add
merchantInfo.merchantId
Add
merchantInfo.amexId
Add
merchantInfo.visa
Add
merchantInfo.mastercard
Add
discount
Add
referralPercent
Add
activeFeatures
Add
bestDays
Add
serves
Add
*Partners that authenticate with client_credentials should provide a user_token.