Skip to content

Creates a Template

Request

Creates a template

Security
X-API-KEY or Authorization
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 integers, (int64)

List of business ids that have access to the template.

curl -i -X POST \
  https://uberall.com/api/templates \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "message": "string",
    "tags": "string",
    "businesses": [
      0
    ]
  }'

Responses

Template created.

Bodyapplication/json
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

Response Template Model

Response
{ "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": [ … ] } }