Skip to content
API Reference/
/
Sync a Location

Sync a Location

Request

Start a sync on all directories for a specific location

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location you want to sync

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

Responses

Location successfully synced

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": {
    "location": { … }
  }
}