Skip to content
API Reference
/
Auto Response
/
List Auto Response Rules with filters

Uberall API (20250708)

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

https://uberall.com/api/

Mock Server

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

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

Check for Auto Response Rule conflicts

Request

Check if there are any other Auto Response Rules that have status ACTIVE, apply to at least one of the businesses or locations in this request, and share at least one of the triggers in this request. When editing an existing Auto Response Rule, its id should be passed in ignoreRule so that it is not returned as a false positive.

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A CheckConflictRequest object

businessesArray of integers(int64)

List of business ids. Only check Auto Response Rules identified by the business ids listed in businesses

locationsArray of integers(int64)

List of location ids. nly check Auto Response Rules identified by the location ids listed in locations

excludedLocationsArray of integers(int64)

List of location ids that should be excluded from the check

triggersArray of strings

Only check Auto Response Rules that also apply to these triggers, use ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR

ignoreRuleinteger(int64)

When editing an Auto Response Rule, send the id from the rule being edited in this field

curl -i -X POST \
  https://uberall.com/api/auto-response/rules/check-conflict \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businesses": [
      0
    ],
    "locations": [
      0
    ],
    "excludedLocations": [
      0
    ],
    "triggers": [
      "string"
    ],
    "ignoreRule": 0
  }'

Responses

Checking for conflicts completed.

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

responseArray of objects(ConflictingRuleResponse)uniquerequired

The actual response object of the response

response[].​idstring

id of conflicting Auto Response Rule

response[].​namestring

Name of conflicting Auto Response Rule

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

List Auto Response Rules with filters

Request

List Auto Response Rules with filters

Security
X-API-KEY or Authorization
Query
businessesArray of strings

Only return Auto Response Rules identified by the business ids listed in businesses

locationsArray of strings

Only return Auto Response Rules identified by the location ids listed in locations

excludedLocationsArray of strings

List of location ids that should be excluded from the result

pageinteger(int64)

Used for pagination

Default 0
sizeinteger(int64)

Used for pagination

Default 10
sortstring

Field to sort the results in, use created_by, date_created or id

directionstring

Direction to sort the results in, use asc for ascending sort or desc for descending sort

curl -i -X GET \
  'https://uberall.com/api/auto-response/rules?businesses=string&locations=string&excludedLocations=string&page=0&size=10&sort=string&direction=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Auto Response Rules 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(RuleResponse)required

The actual response object of the response

response[].​idstringread-only

Uniquely identifies this Auto Response Rule

response[].​businessesArray of objects(ResponseBusiness)

List of business ids that identify this Auto Response Rule

response[].​locationsArray of objects(ResponseLocation)

List of location ids that identify this Auto Response Rule

response[].​excludedLocationsArray of objects(ResponseLocation)

List of location ids that do not identify this Auto Response Rule, even when they might belong to a business that does identify this rule

response[].​namestring

Name for this Auto Response Rule

response[].​statusstring

Status of this Auto Response Rule, either ACTIVE or INACTIVE

Enum"ACTIVE""INACTIVE""DELETED"
response[].​triggersArray of strings

Triggers that apply to this Auto Response Rule, can be ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR

response[].​responsesArray of objects(ResponseValue)

Possible responses for this Auto Response Rule

response[].​dateCreatedstring(date-time)read-only

Date and time of creation

response[].​dateUpdatedstring(date-time)read-only

Date and time of last update

response[].​canEditbooleanread-only

The current user can edit this rule when they have access to all businesses and locations that identify this rule

response[].​locationCountinteger(int32)read-only

Count of locations to which this rule applies

Response
No content

Create an Auto Response Rule

Request

Create an Auto Response Rule

Security
X-API-KEY or Authorization
Body*/*required

Auto Response Rule to be created

businessesArray of integers(int64)
locationsArray of integers(int64)
excludedLocationsArray of integers(int64)
namestring
statusstring
Enum"ACTIVE""INACTIVE""DELETED"
triggersArray of strings
responsesArray of objects(ResponseValue)
ruleResponsesArray of objects(ResponseValue)
curl -i -X POST \
  https://uberall.com/api/auto-response/rules \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Auto Response Rule created

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

Rule Response

response.​idstringread-only

Uniquely identifies this Auto Response Rule

response.​businessesArray of objects(ResponseBusiness)

List of business ids that identify this Auto Response Rule

response.​locationsArray of objects(ResponseLocation)

List of location ids that identify this Auto Response Rule

response.​excludedLocationsArray of objects(ResponseLocation)

List of location ids that do not identify this Auto Response Rule, even when they might belong to a business that does identify this rule

response.​namestring

Name for this Auto Response Rule

response.​statusstring

Status of this Auto Response Rule, either ACTIVE or INACTIVE

Enum"ACTIVE""INACTIVE""DELETED"
response.​triggersArray of strings

Triggers that apply to this Auto Response Rule, can be ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR

response.​responsesArray of objects(ResponseValue)

Possible responses for this Auto Response Rule

response.​dateCreatedstring(date-time)read-only

Date and time of creation

response.​dateUpdatedstring(date-time)read-only

Date and time of last update

response.​canEditbooleanread-only

The current user can edit this rule when they have access to all businesses and locations that identify this rule

response.​locationCountinteger(int32)read-only

Count of locations to which this rule applies

Response
No content

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

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