Skip to content
API Reference/
/
Create a Content List

Create a Content List

Request

Create a content list

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

A ContentList object

Array [
idinteger, (int64)

Content List id

titlestring

The name of the content list: e.g. 'Lunch Menu'

Example:"Lunch Menu"
typestring

The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or CUSTOM. The type cannot be updated after creation.

Enum:"MENU""PEOPLE""PRODUCTS""CUSTOM""SERVICES""EVENTS""FAQ"
descriptionstring

A description of the content list (section)

translationsobject

Language translations for the section title of a content collection

Example:
[
  {
    "hu": { … },
    "fr": { … }
  }
]
itemsArray of objects
]
curl -i -X POST \
  https://uberall.com/api/content-lists \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[
    {
      "id": 0,
      "title": "Lunch Menu",
      "type": "MENU",
      "description": "string",
      "translations": [
        {
          "hu": {
            "title": "Magyar"
          },
          "fr": {
            "title": "Titre Français"
          }
        }
      ],
      "items": [
        {
          "title": "string",
          "description": "string",
          "identifier": "string",
          "listName": "string",
          "id": 0,
          "price": 0,
          "currency": "EUR",
          "category": "Starters, Drinks, Desert, etc.",
          "image": {
            "id": 0,
            "url": "string",
            "type": "LOGO",
            "description": "string",
            "uid": "string"
          },
          "url": "string",
          "priceMax": 0,
          "caloriesLow": 0,
          "caloriesHigh": 0,
          "allergens": "Eggs, Dairy, Wheat, etc.",
          "dietaryRestrictions": "Vegetarian, Halal, etc."
        }
      ]
    }
  ]'

Responses

Content List successfully 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

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "contentList": {
      "id": 0,
      "title": "Lunch Menu",
      "type": "MENU",
      "description": "string",
      "translations": [
        {
          "hu": {
            "title": "Magyar"
          },
          "fr": {
            "title": "Titre Français"
          }
        }
      ],
      "items": [
        {
          "title": "string",
          "description": "string",
          "identifier": "string",
          "listName": "string",
          "id": 0,
          "price": 0,
          "currency": "EUR",
          "category": "Starters, Drinks, Desert, etc.",
          "image": {
            "id": 0,
            "url": "string",
            "type": "LOGO",
            "description": "string",
            "uid": "string"
          },
          "url": "string",
          "priceMax": 0,
          "caloriesLow": 0,
          "caloriesHigh": 0,
          "allergens": "Eggs, Dairy, Wheat, etc.",
          "dietaryRestrictions": "Vegetarian, Halal, etc."
        }
      ]
    }
  }
}