API Reference
/
Data Points
/
Mark as Unread

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

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

Mark as Read

Request

Mark one or several inbox items as read

Query
businessIdsArray of strings

Filter by business ids

countriesArray of strings

Filter by countries. ISO 3166-1 alpha-2 codes

zipstring

Only change inbox items for locations where zip starts with given parameter

dataPointTypesArray of strings

Filter by type of datapoints

Example: dataPointTypes=[PHOTO, REVIEW, CHECKIN]
directoryTypesArray of strings

Filter by directories

ratingsArray of strings

Only change inbox items with a rating included in ratings

repliedboolean

Only show elements you have/you have not replied to

selectAllbooleanrequired

If all data points matching the current filter settings should be marked as read

idsArray of strings

The uberall unique ids for the inbox items you want to mark as read

excludeIdsArray of strings

If selectAll is set to true this parameter can contain a list of data point ids that should not be marked as read

querystring

Filter by name

curl -i -X POST \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/read?businessIds=string&countries=string&dataPointTypes=%5BPHOTO%2C%20REVIEW%2C%20CHECKIN%5D&directoryTypes=string&excludeIds=string&ids=string&query=string&ratings=string&replied=true&selectAll=true&zip=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Inbox items marked as read

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

Mark as Unread

Request

Mark one or several inbox items as unread

Query
businessIdsArray of strings

Filter by business ids

countriesArray of strings

Filter by countries. ISO 3166-1 alpha-2 codes

zipstring

Only change inbox items for locations where zip starts with given parameter

dataPointTypesArray of strings

Filter by type of datapoints

Example: dataPointTypes=[PHOTO, REVIEW, CHECKIN]
directoryTypesArray of strings

Filter by directories

ratingsArray of strings

Only change inbox items with a rating included in ratings

repliedboolean

Only show elements you have/you have not replied to

selectAllbooleanrequired

If all data points matching the current filter settings should be marked as unread

idsArray of strings

The uberall unique ids for the inbox items you want to mark as unread

excludeIdsArray of strings

If selectAll is set to true this parameter can contain a list of data point ids that should not be marked as unread

querystring

Filter by name

curl -i -X DELETE \
  'https://docs.uberall.com/_mock/apis/swagger/data-points/read?businessIds=string&countries=string&dataPointTypes=%5BPHOTO%2C%20REVIEW%2C%20CHECKIN%5D&directoryTypes=string&excludeIds=string&ids=string&query=string&ratings=string&replied=true&selectAll=true&zip=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Inbox items marked as unread

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

Get All Data Points

Request

Get all data points, potentially filtered by directory, business, rating...

Query
maxinteger(int64)

Used for pagination. Maximum number of results per page

pageinteger(int64)

The page number for pagination

labelsArray of strings

Filter by location labels

countriesArray of strings

The countries you want data points for. ISO 3166-1 alpha-2 codes

businessIdsArray of strings

Ids of businesses you want data points for

locationIdsArray of strings

The ids of the locations you want data points for

zipstring

Only return inbox items for locations where zip starts with given parameter

dataPointTypesArray of strings

Types of datapoints you want inbox items for

Example: dataPointTypes=[PHOTO, REVIEW, CHECKIN]
directoryTypesArray of strings

Directories you want inbox items for

ratingsArray of strings

Only return inbox items with a rating included in ratings

readboolean

Only show read/not read elements

repliedboolean

Only show elements you have/you have not replied to

textboolean

Only return data points with text or without

querystring

Filter by name

minActionDatestring

The min date of the DataPoint as unix timestamp in milliseconds

Example: minActionDate=1514764800000
maxActionDatestring

The max date of the DataPoint as unix timestamp in milliseconds

Example: maxActionDate=1514764800000
minThreadActionDatestring

The min date of the last interaction with a DataPoint as unix timestamp in milliseconds

Example: minThreadActionDate=1514764800000
maxThreadActionDatestring

The max date of the last interaction with a DataPoint as unix timestamp in milliseconds

Example: maxThreadActionDate=1514764800000
fieldMaskstring

The fields you want to include in the response

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/data-points?businessIds=string&countries=string&dataPointTypes=%5BPHOTO%2C%20REVIEW%2C%20CHECKIN%5D&directoryTypes=string&fieldMask=string&labels=string&locationIds=string&max=0&maxActionDate=1514764800000&maxThreadActionDate=1514764800000&minActionDate=1514764800000&minThreadActionDate=1514764800000&page=0&query=string&ratings=string&read=true&replied=true&text=true&zip=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Success

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

The actual response object of the response

response.​inboxobject

Inbox Response Model

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "inbox": { … }
  }
}

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

Menu Items

Locations Hub - Locations - Menu Items

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