Skip to content

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
Languages
Servers

https://uberall.com/api/

Mock Server

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

Operations

Business Connections

Set up - Business Connections

Operations
Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations
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
Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

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

Request

Disconnect the Instagram Page connected to the specified location

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the location

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

Responses

Instagram page has been disconnected

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.​successboolean

Success

Example: true
Response
No content

Request

Used for MANUALLY_CREATED listings to update listingUrl and syncStatus

Security
X-API-KEY or Authorization
Path
idstringrequired

The ID of the MANUALLY_CREATED listing to be updated

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

Responses

Successfully updated Listing

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
No content

Request

Flag a listing if it is not corresponding to the right location

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique ID for the listing to flag

curl -i -X PUT \
  'https://uberall.com/api/listings/{id}/flag' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully flagged Listing

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
No content
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