Skip to content
API Reference/
/
Sync All Business' Locati...

Sync All Business' Locations

Request

Start a sync on all directories for all locations in the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.

Security
X-API-KEY or Authorization
Path
businessIdstringrequired

The uberall unique id of the business

curl -i -X POST \
  'https://uberall.com/api/businesses/{businessId}/locations/sync' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Sync successfully started

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"
    }
  }
}