Skip to content
API Reference/
/
Update a Business

Update a Business

Request

Edit information of the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the business

Bodyapplication/jsonrequired

A Business object

idinteger, (int64)

The uberall unique id for the business

namestring

The business's name

typestring

Business type. One of SMB or ENTERPRISE

Enum:"SMB""ENTERPRISE"
Example:"[SMB, ENTERPRISE]"
streetAndNostring

Address of the business

addressLine2string

An address extra: e.g. building, floor...

Example:"building, floor..."
provincestring

Province. Only send when not blank

zipstring

Zipcode of the business

citystring

City of the business

identifierstring

The business identifier based on your internal identification system

countrystring

Country of the business

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

Business's phone number

productPlanobject

The chosen product plan

preSyncboolean

Pre sync

translationLocalesArray of objects, unique

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

dateCreatedstring, (date-time)

The date and time the business was created in uberall database

statusstring

Business's status

Enum:"CREATED""NOT_CONFIRMED""ACTIVE""DELETED"
countryPricesArray of objects, unique

List of country specific prices

defaultPriceinteger, (int32)

Business default price in cent

defaultOriginalPriceinteger, (int32)

Default Original Price in cent

defaultPriceSetupinteger, (int32)

Business default setup price in cent

customFieldsstring

Custom fields allow for additional information to be added at the location level. All locations within the business will have the same list of custom fields.

dateExpirationstring, (date-time)

The date the business's contract expires

businessSyncableboolean

True if the business is allowed to start a sync. Only relevant for Businesses with more than 10 locations.

numOfLocationsinteger, (int32)

Number of active locations

effectiveDatestring, (date-time)

Date when the business automatically changes its product plan to the new product plan (defined by nextProductPlanId)

nextProductPlanIdinteger, (int64)

ID of the next product plan applied for the business on the defined effectiveDate

priceRetailinteger, (int64)

Retail price

contractDurationinteger, (int64)

Contract duration of the chosen product plan in months

defaultPriceMininteger, (int64)
defaultCurrencystring
curl -i -X PATCH \
  'https://uberall.com/api/businesses/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "name": "string",
    "type": "[SMB, ENTERPRISE]",
    "streetAndNo": "string",
    "addressLine2": "building, floor...",
    "province": "string",
    "zip": "string",
    "city": "string",
    "identifier": "string",
    "country": "AF",
    "phone": "string",
    "productPlan": {
      "defaultPlan": true,
      "description": "string",
      "identifier": "string",
      "name": "string",
      "status": "ACTIVE",
      "automationDirectories": [
        "FOURSQUARE"
      ],
      "billingPeriod": 0,
      "countryPrices": [
        {
          "country": "AF",
          "price": 0,
          "marketDevelopmentFunds": 99,
          "priceSetup": 0
        }
      ],
      "defaultMarketDevelopmentFunds": 0,
      "defaultOriginalPrice": 0,
      "defaultPrice": 0,
      "defaultPriceSetup": 0,
      "duration": 0,
      "features": [
        "ADS"
      ],
      "initialBillingPeriod": 0,
      "initialDuration": 0
    },
    "preSync": true,
    "translationLocales": [
      {}
    ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "countryPrices": [
      {
        "country": "AF",
        "price": 0,
        "marketDevelopmentFunds": 99,
        "priceSetup": 0
      }
    ],
    "defaultPrice": 0,
    "defaultOriginalPrice": 0,
    "defaultPriceSetup": 0,
    "customFields": "string",
    "dateExpiration": "2019-08-24T14:15:22Z",
    "businessSyncable": true,
    "numOfLocations": 0,
    "effectiveDate": "2019-08-24T14:15:22Z",
    "nextProductPlanId": 0,
    "priceRetail": 0,
    "contractDuration": 0,
    "defaultPriceMin": 0,
    "defaultCurrency": "string"
  }'

Responses

Successfully edited Business

Body*/*
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": {
      "id": 0,
      "name": "string",
      "type": "[SMB, ENTERPRISE]",
      "streetAndNo": "string",
      "addressLine2": "building, floor...",
      "province": "string",
      "zip": "string",
      "city": "string",
      "identifier": "string",
      "country": "AF",
      "phone": "string",
      "productPlan": {
        "defaultPlan": true,
        "description": "string",
        "identifier": "string",
        "name": "string",
        "status": "ACTIVE",
        "automationDirectories": [
          "FOURSQUARE"
        ],
        "billingPeriod": 0,
        "countryPrices": [
          {
            "country": "AF",
            "price": 0,
            "marketDevelopmentFunds": 99,
            "priceSetup": 0
          }
        ],
        "defaultMarketDevelopmentFunds": 0,
        "defaultOriginalPrice": 0,
        "defaultPrice": 0,
        "defaultPriceSetup": 0,
        "duration": 0,
        "features": [
          "ADS"
        ],
        "initialBillingPeriod": 0,
        "initialDuration": 0
      },
      "preSync": true,
      "translationLocales": [
        {}
      ],
      "dateCreated": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "countryPrices": [
        {
          "country": "AF",
          "price": 0,
          "marketDevelopmentFunds": 99,
          "priceSetup": 0
        }
      ],
      "defaultPrice": 0,
      "defaultOriginalPrice": 0,
      "defaultPriceSetup": 0,
      "customFields": "string",
      "dateExpiration": "2019-08-24T14:15:22Z",
      "businessSyncable": true,
      "numOfLocations": 0,
      "effectiveDate": "2019-08-24T14:15:22Z",
      "nextProductPlanId": 0,
      "priceRetail": 0,
      "contractDuration": 0,
      "defaultPriceMin": 0,
      "defaultCurrency": "string"
    }
  }
}