/

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description

Overview

URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

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

Get All Templates

Request

Get all templates, potentially filtered by businesses, locations, authors, ...

Query

querystring

Free text search that applies to title and message

tagsstring

The tags values you want templates for

minLastEditedstring

The min date of the last update of the template

maxLastEditedstring

The max date of the last update of the template

minTimesUsedinteger(int64)

The min usage count you want templates for

maxTimesUsedinteger(int64)

The max usage count you want templates for

createdBystring

The ids of authors you want templates for

businessesArray of integers(int64)

The ids of businesses you want templates for

locationsstring

The ids of locations you want templates for

pageinteger(int64)

Used for pagination. Page number we're interested in

sizeinteger(int64)

Number of templates per page

sortstring

Name of the field we want to sort

directionstring

Use asc for ascending sort or desc for descending sort

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/templates?businesses=0&createdBy=string&direction=string&locations=string&maxLastEdited=string&maxTimesUsed=0&minLastEdited=string&minTimesUsed=0&page=0&query=string&size=0&sort=string&tags=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Templates retrieved

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 objects(ResponseTemplate)required

The actual response object of the response

response[].idinteger(int64)

The Uberall unique id of the template

response[].titlestring

The title of the template

response[].messagestring

The reply's text of the template

response[].usageCountinteger(int64)

Number of times a template has been used

response[].statusstring

The status of the template

response[].tagsArray of strings

The list of tags for the template

response[].dateCreatedstring(date-time)

The date in which the template was created

response[].lastEditedstring(date-time)

The date in which the template was last edited

response[].createdByobject

Response User Model

response[].lastEditedByobject

Response User Model

response[].businessesArray of integers(int32)

The list of business ids the templated was created for

Response

No content

Creates a Template

Request

Creates a template

Body*/*required

Template to create

titlestringrequired

The title of the template

messagestringrequired

The message that will be used in the response

tagsstringrequired

Template tags used for filtering

businessesArray of strings

curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/templates \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Template created.

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

Response Template Model

response.idinteger(int64)

The Uberall unique id of the template

response.titlestring

The title of the template

response.messagestring

The reply's text of the template

response.usageCountinteger(int64)

Number of times a template has been used

response.statusstring

The status of the template

response.tagsArray of strings

The list of tags for the template

response.dateCreatedstring(date-time)

The date in which the template was created

response.lastEditedstring(date-time)

The date in which the template was last edited

response.createdByobject

Response User Model

response.lastEditedByobject

Response User Model

response.businessesArray of integers(int32)

The list of business ids the templated was created for

Response

application/json

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "id": 0,
    "title": "string",
    "message": "string",
    "usageCount": 0,
    "status": "string",
    "tags": [ … ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "lastEdited": "2019-08-24T14:15:22Z",
    "createdBy": { … },
    "lastEditedBy": { … },
    "businesses": [ … ]
  }
}

Get a Template

Request

Get all information about a specific template

Path

idstringrequired

The uberall unique id of the template

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

Responses

Template retrieved

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

Response Template Model

response.idinteger(int64)

The Uberall unique id of the template

response.titlestring

The title of the template

response.messagestring

The reply's text of the template

response.usageCountinteger(int64)

Number of times a template has been used

response.statusstring

The status of the template

response.tagsArray of strings

The list of tags for the template

response.dateCreatedstring(date-time)

The date in which the template was created

response.lastEditedstring(date-time)

The date in which the template was last edited

response.createdByobject

Response User Model

response.lastEditedByobject

Response User Model

response.businessesArray of integers(int32)

The list of business ids the templated was created for

Response

No content

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

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