Skip to content
API Reference
/
Custom Items
/
Update a Custom Item

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

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

Delete a Custom Item

Request

Delete a custom item

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the custom item

curl -i -X DELETE \
  'https://uberall.com/api/custom-items/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully deleted custom item

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 a Custom Item

Request

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

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the custom item

Bodyapplication/jsonrequired

CustomItem object to update

titlestringrequired

mandatory, the custom name, e.g. 'Strong Coffee'

descriptionstring
identifierstring
listNamestring
idinteger(int64)

The uberall unique id for the custom item

priceinteger(int32)

optional, the price of the custom, e.g. 1500 ( i.e. 15,00 EUR )

currencyobject

optional, indicating the currency for price and priceMax in ISO-4217, e.g. EUR

categorystring

optional, a category name, e.g. 'Coffee'

Example: "Coffee"
videoobject

optional, a video about the custom

unitstring

optional, indicating the unit of measure, e.g. 'per kg'

Example: "per kg"
urlstring

optional, a url related to the custom item

priceMaxinteger(int32)

optional, indicating there is a price range, e.g. 2500 ( i.e. 25,00 EUR )

imageobject

Image of the custom-item (use the Image object format)

curl -i -X PATCH \
  'https://uberall.com/api/custom-items/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "id": 0,
    "price": 0,
    "currency": {},
    "category": "Coffee",
    "video": {
      "id": 0,
      "url": "string",
      "description": "string",
      "type": "YOUTUBE"
    },
    "unit": "per kg",
    "url": "string",
    "priceMax": 0,
    "image": {
      "id": 0,
      "url": "string",
      "type": "LOGO",
      "description": "string",
      "uid": "string"
    }
  }'

Responses

Successfully updated custom item

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

responseobjectrequired

The actual response object of the response

response.​customItemobject

Custom Item

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

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