Skip to content

Mark as Unread

Request

Mark one or several inbox items as unread

Security
X-API-KEY or Authorization
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://uberall.com/api/data-points/read?businessIds=string&countries=string&zip=string&dataPointTypes=%5BPHOTO%2C%20REVIEW%2C%20CHECKIN%5D&directoryTypes=string&ratings=string&replied=true&selectAll=true&ids=string&excludeIds=string&query=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Inbox items marked as unread

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

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "success": true
  }
}