Skip to content
API Reference/
/
Delete an Event using ide...

Uberall API (20250708)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
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

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

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

Create an Event

Request

Create a new event. It can be added to a content list later

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

Event object that needs to be created

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.​eventobject

Event

curl -i -X POST \
  https://uberall.com/api/events \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Event successfully created

Bodyapplication/json
titlestringrequired

The title of the event

descriptionstring

The description of the event: e.g. "Watch a lot of awesome movies."

identifierstring

Unique Identifier for the Event

listNamestring

Name of the Event

timeStartstring(date-time)required

The date the event starts

timeEndstring(date-time)required

The date the event ends

videoobject

A video to promote the event

urlstring

The url of the page with more details about the event

Response
application/json
{
  "title": "string",
  "description": "string",
  "identifier": "string",
  "listName": "string",
  "timeStart": "2019-08-24T14:15:22Z",
  "timeEnd": "2019-08-24T14:15:22Z",
  "video": {
    "id": 0,
    "url": "string",
    "description": "string",
    "type": "YOUTUBE"
  },
  "url": "string"
}

Delete an Event using identifier

Request

Delete an event identified by identifier in the url param

Security
X-API-KEY or Authorization
curl -i -X DELETE \
  https://uberall.com/api/events \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Event successfully 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
No content

Update an Event using identifier

Request

Make changes to an event, always use ?identifier= in url param to identify the event uniquely Any blank parameter deletes an old value, any unspecified parameter does nothing

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

Event object that needs to be updated

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.​eventobject

Event

curl -i -X PATCH \
  https://uberall.com/api/events \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Event successfully updated

Bodyapplication/json
titlestringrequired

The title of the event

descriptionstring

The description of the event: e.g. "Watch a lot of awesome movies."

identifierstring

Unique Identifier for the Event

listNamestring

Name of the Event

timeStartstring(date-time)required

The date the event starts

timeEndstring(date-time)required

The date the event ends

videoobject

A video to promote the event

urlstring

The url of the page with more details about the event

Response
application/json
{
  "title": "string",
  "description": "string",
  "identifier": "string",
  "listName": "string",
  "timeStart": "2019-08-24T14:15:22Z",
  "timeEnd": "2019-08-24T14:15:22Z",
  "video": {
    "id": 0,
    "url": "string",
    "description": "string",
    "type": "YOUTUBE"
  },
  "url": "string"
}

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

Locations

Locations

Operations