Create a Business

Request

Create a Business belonging to the SalesPartner of the current User. User needs UserRole ADMIN or ACCOUNT_MANAGER.

Security

X-API-KEY or Authorization

Bodyapplication/jsonrequired

A Business object

namestringrequired

Name of the business

Example:"Minimalistic business"

streetAndNostring

Address of the business

Example:"Piac utca 22."

addressLine2string

An address extra

zipstring

Zip code of the business

Example:"4025"

citystring

City of the business

Example:"Debrecen"

countrystring

Country of the business

Enum:"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"

Example:"HU"

contractDurationinteger, (int64)

Contract Duration

Example:12

productPlaninteger, (int64)

Product plan

Example:2404

translationLocalesArray of objects, unique

Locales the business's locations can be translated into. Requires the LOCATION_TRANSLATION feature on the business's product plan.

curl -i -X POST \
  https://uberall.com/api/businesses \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Minimalistic business",
    "streetAndNo": "Piac utca 22.",
    "addressLine2": "string",
    "zip": "4025",
    "city": "Debrecen",
    "country": "HU",
    "contractDuration": 12,
    "productPlan": 2404,
    "translationLocales": [
      {}
    ]
  }'

Responses

Business successfully created

Bodyapplication/json

statusstringrequired

Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "business": { … }
  }
}