Create an Auto Response Rule

Request

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

ruleResponsesArray of objects

curl -i -X POST \
  https://uberall.com/api/auto-response/rules \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businesses": [
      0
    ],
    "locations": [
      0
    ],
    "excludedLocations": [
      0
    ],
    "name": "string",
    "status": "ACTIVE",
    "triggers": [
      "string"
    ],
    "responses": [
      {
        "response": "string",
        "isOpenAI": true
      }
    ],
    "ruleResponses": [
      {
        "response": "string",
        "isOpenAI": true
      }
    ]
  }'

Responses

Auto Response Rule created

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

Rule Response

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "id": "string",
    "businesses": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "locations": [
      {
        "id": 0,
        "name": "string",
        "business": {
          "id": 0,
          "name": "string"
        }
      }
    ],
    "excludedLocations": [
      {
        "id": 0,
        "name": "string",
        "business": {
          "id": 0,
          "name": "string"
        }
      }
    ],
    "name": "string",
    "status": "ACTIVE",
    "triggers": [
      "string"
    ],
    "responses": [
      {
        "response": "string",
        "isOpenAI": true
      }
    ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "dateUpdated": "2019-08-24T14:15:22Z",
    "canEdit": true,
    "locationCount": 0
  }
}