API Reference
/
Templates
/
Delete a Template

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

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Get a Template

Request

Get all information about a specific template

Path
idstringrequired

The uberall unique id of the template

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/templates/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Template 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

responseobjectrequired

Response Template Model

response.​idinteger(int64)

The Uberall unique id of the template

response.​titlestring

The title of the template

response.​messagestring

The reply's text of the template

response.​usageCountinteger(int64)

Number of times a template has been used

response.​statusstring

The status of the template

response.​tagsArray of strings

The list of tags for the template

response.​dateCreatedstring(date-time)

The date in which the template was created

response.​lastEditedstring(date-time)

The date in which the template was last edited

response.​createdByobject

Response User Model

response.​lastEditedByobject

Response User Model

response.​businessesArray of integers(int32)

The list of business ids the templated was created for

Response
No content

Delete a Template

Request

Delete a Template

Path
idstringrequired

The uberall unique id of the template

curl -i -X DELETE \
  'https://docs.uberall.com/_mock/apis/swagger/templates/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Template deleted.

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

Update a Template

Request

Make changes to a template. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path
idstringrequired

The uberall unique id of the template

Body*/*required

Template to update

titlestringrequired

The title of the template

messagestringrequired

The message that will be used in the response

tagsstringrequired

Template tags used for filtering

businessesArray of strings
curl -i -X PATCH \
  'https://docs.uberall.com/_mock/apis/swagger/templates/{id}' \
  -H 'Content-Type: */*' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Template updated

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

Response Template Model

response.​idinteger(int64)

The Uberall unique id of the template

response.​titlestring

The title of the template

response.​messagestring

The reply's text of the template

response.​usageCountinteger(int64)

Number of times a template has been used

response.​statusstring

The status of the template

response.​tagsArray of strings

The list of tags for the template

response.​dateCreatedstring(date-time)

The date in which the template was created

response.​lastEditedstring(date-time)

The date in which the template was last edited

response.​createdByobject

Response User Model

response.​lastEditedByobject

Response User Model

response.​businessesArray of integers(int32)

The list of business ids the templated was created for

Response
No content

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