Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
Languages
Servers
Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

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 Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Social Posting Templates

Products - Social Posting - Social Posting Templates

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

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

Delete a single LocationGroup

Request

Can be used for deleting a single LocationGroup.

Path
idstringrequired

ID of the LocationGroup that should be deleted.

curl -i -X DELETE \
  'https://docs.uberall.com/_mock/apis/swagger/location-groups/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

LocationGroup deleted successfully

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

The actual response object of the response

response.​idinteger(int64)

ID of the LocationGroup.

response.​lastUpdatedstring(date-time)

Last updated date of the Location Group

response.​namestring

Name of the LocationGroup.

response.​statusstring

Status of the Location Group

Enum"ACTIVE""DELETED"
response.​usersArray of objects(UserDetails)
response.​creatorinteger(int64)
response.​salesPartnerinteger(int64)
response.​locationsCountinteger(int32)
response.​locationsArray of objects(LocationDetails)
Response
No content

Update a single LocationGroup

Request

Can be used for updating a single LocationGroup.

Path
idstringrequired

ID of the LocationGroup that should be updated.

Body*/*required

LocationGroup to update

namestring

Name (String) of the LocationGroup

statusstring

Status of the LocationGroup, defaults to "ACTIVE", supported values: ["ACTIVE"].

Enum"ACTIVE""DELETED"
locationsArray of integers(int64)

List of location IDs (Long) that shall be assigned to the new LocationGroup. For clearing this field you can send either null or an empty list [].

usersArray of integers(int64)

List of user IDs (Long) that shall be assigned to the new LocationGroup. For clearing this field you can send either null or an empty list [].

curl -i -X PATCH \
  'https://docs.uberall.com/_mock/apis/swagger/location-groups/{id}' \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

LocationGroup updated successfully

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

The actual response object of the response

response.​idinteger(int64)

ID of the LocationGroup.

response.​lastUpdatedstring(date-time)

Last updated date of the Location Group

response.​namestring

Name of the LocationGroup.

response.​statusstring

Status of the Location Group

Enum"ACTIVE""DELETED"
response.​usersArray of objects(UserDetails)
response.​creatorinteger(int64)
response.​salesPartnerinteger(int64)
response.​locationsCountinteger(int32)
response.​locationsArray of objects(LocationDetails)
Response
No content

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