Skip to content
API Reference/
/
Update suggestions

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api/
Mock Server
https://docs.uberall.com/_mock/apis/swagger/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations

Get suggestions

Request

Get location suggestions given a search data

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

Query
languagestring

Filter suggestion attributes by language

directoryTypesstring

Filter suggestions by directories

curl -i -X GET \
  'https://uberall.com/api/locations/{id}/suggestions?language=string&directoryTypes=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved suggestions

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Suggestion Response Model

response.​idinteger(int64)

Id of the location

response.​namestring

Name of the location

response.​streetAndNumberstring

Street and streetNumber of the location

response.​zipstring

Zip of the location

response.​citystring

City of the location

response.​countrystring

Country of the location

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
response.​statusstring

Status of the location

Enum"CREATED""ACTIVE""INACTIVE""CANCELLED""DELETED""CLOSED"
response.​suggestionsForFieldsArray of objects

Map containing fields and the suggested values from different directories.

Response
No content

Update suggestions

Request

Update the given suggestion object, used to track the status of incoming suggestions. Note that rejecting a suggestion does not delete it, and accepting the suggestion won't automatically apply it to the location.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the location

Body*/*required

List of Maps with both an id and a status key: [[id: 123, status: ACCEPTED], ...]

Array [
idinteger(int64)

id of the Suggestion

statusstring

ACCEPTED, DECLINED or ACTIVE (if no decision was made for accepting/declining the suggestion)

Enum"HIDDEN""PENDING""ACCEPTED""DECLINED""DECLINED_OLD_API"
valueobject

Suggestion Value

directorystring

Suggestion from directory

Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
]
curl -i -X PUT \
  'https://uberall.com/api/locations/{id}/suggestions' \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Successfully updated suggestions

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseArray of objectsrequired

The actual response object of the response

response[].​idinteger(int64)

id of the Suggestion

response[].​statusstring

ACCEPTED, DECLINED or ACTIVE (if no decision was made for accepting/declining the suggestion)

Enum"HIDDEN""PENDING""ACCEPTED""DECLINED""DECLINED_OLD_API"
response[].​valueobject

Suggestion Value

response[].​directorystring

Suggestion from directory

Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP""YELP_API""MEINESTADT""YELLOW_MAP""FOCUS"
Response
No content

Get Location Suggestions

Request

Get a list of suggestions for all locations managed by the logged user

Security
X-API-KEY or Authorization
Query
querystring

Filter by name, zip, street, city, label

Example: query=Berlin
sortstring

The location property to sort by (ascending unless order is specified)

orderstring

use asc for ascending sort or desc for descending sort

maxinteger(int64)

Used for pagination. Maximum number of results per page.

identifierstring

The location identifier, based on your internal identification system, you want the suggestions for.

offsetinteger(int64)

Offset used for pagination. Default: 0

businessIdArray of integers(int64)

The ids of the businesses you want suggestions for

locationIdsArray of integers(int64)

The ids of the locations you want suggestions for.

curl -i -X GET \
  'https://uberall.com/api/locations/suggestions?query=Berlin&sort=string&order=string&max=0&identifier=string&offset=0&businessId=0&locationIds=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved suggestions

Bodyapplication/json
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Search response object containing pagination details and a list of suggestion responses

response.​offsetinteger(int32)

Offset for pagination

Example: 0
response.​maxinteger(int32)

Maximum number of results per page

Example: 10
response.​countinteger(int32)

Total count of results

Example: 100
response.​locationsArray of objects
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "offset": 0,
    "max": 10,
    "count": 100,
    "locations": [ … ]
  }
}

Locations

Locations

Operations