---
title: "Create a collection"
method: POST
path: "/collections"
tags: ["Collection Management"]
---

# Create a collection

`POST /collections`

Create a new collection managed by the current API user. If the user specifies a set of locations for the collections, users managing the whole set of locations can also manage the collection.

## Request body

- object — Content Collection
  - `id` integer — Collection id
  - `identifier` string, required — Mandatory - A unique identifier for the collection
  - `name` string, required — Mandatory - Name of the content collection
  - `description` string — A description of the collection
  - `type` 'MENU' | 'PEOPLE' | 'PRODUCTS' | 'CUSTOM' | 'SERVICES' | 'EVENTS' | 'FAQ', required — Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM
  - `contentLists` object[] — Mandatory - Sections within the content collections
    - `id` integer — Content List id
    - `title` string — The name of the content list: e.g. 'Lunch Menu'
    - `type` 'MENU' | 'PEOPLE' | 'PRODUCTS' | 'CUSTOM' | 'SERVICES' | 'EVENTS' | 'FAQ' — The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or CUSTOM. The type cannot be updated after creation.
    - `description` string — A description of the content list (section)
    - `translations` object — Language translations for the section title of a content collection
      - `locale` object — Content List Translation
        - `field` 'TITLE' — The field for translation
    - `items` object[]
      - `title` string, required — Title
      - `description` string — Description of the menu item: e.g. 'With mozzarella, fresh basil and tomatoes'
      - `identifier` string — Unique Identifier for the Menu
      - `listName` string
      - `id` integer — The uberall unique id for the menu item
      - `price` integer — Price of the menu item in cents: e.g. '1500' for 15 €
      - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'AUD' | 'RUB' | 'JPY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency used for prices in ISO-4217: e.g. EUR, USD, CHF
      - `category` string — Category or section of the menu item (e.g. Starters, Drinks, Desert, etc.)
      - `image` object — Image of the menu (use the Image object format)
        - `id` integer — The uberall unique id for the image
        - `url` string, required — Image url
        - `type` 'LOGO' | 'MAIN' | 'IMAGE', required — The image type, one of [LOGO, MAIN, IMAGE]
        - `description` string — Description of the image
        - `uid` string, required — user identifier of the image
      - `url` string — A valid page url with more details about the item
      - `priceMax` integer — Maximum price if you want to use a price range for the item
      - `caloriesLow` integer — The lowest possible number of calories for a menu item
      - `caloriesHigh` integer — The high end of the range of calories for a menu item
      - `allergens` string[] — Allergens in the food item (e.g. Eggs, Dairy, Wheat, etc.)
      - `dietaryRestrictions` string[] — Restrictive diet the menu item fits into (e.g. Vegetarian, Halal, etc.)
  - `locationIds` integer[] — Location Ids that should be associated with this collection
  - `isReadOnly` boolean — Special field for FE indicating if the collection is read-only for the logged in user
  - `cuisineType` 'AMERICAN' | 'ASIAN' | 'BRAZILIAN' | 'BREAKFAST' | 'BRUNCH' | 'CHICKEN' | 'CHINESE' | 'FAMILY' | 'FAST_FOOD' | 'FRENCH' | 'GREEK' | 'GERMAN' | 'HAMBURGER' | 'INDIAN' | 'INDONESIAN' | 'ITALIAN' | 'JAPANESE' | 'KOREAN' | 'LATIN_AMERICAN' | 'MEDITERRANEAN' | 'MEXICAN' | 'PAKISTANI' | 'PIZZA' | 'SEAFOOD' | 'SPANISH' | 'SUSHI' | 'THAI' | 'TURKISH' | 'VEGETARIAN' | 'VIETNAMESE' | 'OTHER_CUISINE' — Only applicable to Menu content collections - indicates the cuisine the restaurant serves
  - `url` string — Applicable to Menu collections only - url to the brand webpage menu

## Response `200`

Collection created

- object
  - `status` 'SUCCESS' | 'PENDING' | 'QUOTA_LIMIT_EXCEED' | 'NOT_AUTHORIZED' | 'FORBIDDEN' | 'BAD_ACCESS_TOKEN' | 'BAD_PRIVATE_KEY' | 'BAD_PUBLIC_KEY' | 'MISSING_PARAMETER' | 'INVALID_PARAMETER' | 'WRONG_PARAMETER_TYPE' | 'CONFLICT' | 'RESOURCE_LOCKED' | 'SERVER_ERROR' | 'ERROR' | 'NOT_FOUND' | 'BAD_REQUEST' | 'USER_ERROR' | 'PARTIAL_ERROR' | 'SERVICE_TEMPORARILY_UNAVAILABLE', required
  - `message` string — (optional) Holds further information about the response
  - `warnings` string[] — (optional) Holds further warnings
  - `response` object, required — The actual response object of the response
    - `collection` object — Content Collection
      - `id` integer — Collection id
      - `identifier` string, required — Mandatory - A unique identifier for the collection
      - `name` string, required — Mandatory - Name of the content collection
      - `description` string — A description of the collection
      - `type` 'MENU' | 'PEOPLE' | 'PRODUCTS' | 'CUSTOM' | 'SERVICES' | 'EVENTS' | 'FAQ', required — Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM
      - `contentLists` object[] — Mandatory - Sections within the content collections
        - `id` integer — Content List id
        - `title` string — The name of the content list: e.g. 'Lunch Menu'
        - `type` 'MENU' | 'PEOPLE' | 'PRODUCTS' | 'CUSTOM' | 'SERVICES' | 'EVENTS' | 'FAQ' — The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or CUSTOM. The type cannot be updated after creation.
        - `description` string — A description of the content list (section)
        - `translations` object — Language translations for the section title of a content collection
          - `locale` object — Content List Translation
            - `field` 'TITLE' — The field for translation
        - `items` object[]
          - `title` string, required — Title
          - `description` string — Description of the menu item: e.g. 'With mozzarella, fresh basil and tomatoes'
          - `identifier` string — Unique Identifier for the Menu
          - `listName` string
          - `id` integer — The uberall unique id for the menu item
          - `price` integer — Price of the menu item in cents: e.g. '1500' for 15 €
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'AUD' | 'RUB' | 'JPY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' — Currency used for prices in ISO-4217: e.g. EUR, USD, CHF
          - `category` string — Category or section of the menu item (e.g. Starters, Drinks, Desert, etc.)
          - `image` object — Image of the menu (use the Image object format)
            - `id` integer — The uberall unique id for the image
            - `url` string, required — Image url
            - `type` 'LOGO' | 'MAIN' | 'IMAGE', required — The image type, one of [LOGO, MAIN, IMAGE]
            - `description` string — Description of the image
            - `uid` string, required — user identifier of the image
          - `url` string — A valid page url with more details about the item
          - `priceMax` integer — Maximum price if you want to use a price range for the item
          - `caloriesLow` integer — The lowest possible number of calories for a menu item
          - `caloriesHigh` integer — The high end of the range of calories for a menu item
          - `allergens` string[] — Allergens in the food item (e.g. Eggs, Dairy, Wheat, etc.)
          - `dietaryRestrictions` string[] — Restrictive diet the menu item fits into (e.g. Vegetarian, Halal, etc.)
      - `locationIds` integer[] — Location Ids that should be associated with this collection
      - `isReadOnly` boolean — Special field for FE indicating if the collection is read-only for the logged in user
      - `cuisineType` 'AMERICAN' | 'ASIAN' | 'BRAZILIAN' | 'BREAKFAST' | 'BRUNCH' | 'CHICKEN' | 'CHINESE' | 'FAMILY' | 'FAST_FOOD' | 'FRENCH' | 'GREEK' | 'GERMAN' | 'HAMBURGER' | 'INDIAN' | 'INDONESIAN' | 'ITALIAN' | 'JAPANESE' | 'KOREAN' | 'LATIN_AMERICAN' | 'MEDITERRANEAN' | 'MEXICAN' | 'PAKISTANI' | 'PIZZA' | 'SEAFOOD' | 'SPANISH' | 'SUSHI' | 'THAI' | 'TURKISH' | 'VEGETARIAN' | 'VIETNAMESE' | 'OTHER_CUISINE' — Only applicable to Menu content collections - indicates the cuisine the restaurant serves
      - `url` string — Applicable to Menu collections only - url to the brand webpage menu

## Other responses

- `400` — Bad Request - The request was invalid or cannot be otherwise served
- `401` — Unauthorized - Authentication credentials are missing or invalid
- `403` — Forbidden - The request is understood, but has been refused or access is not allowed
- `404` — Not Found - The requested resource could not be found
- `409` — Conflict - The request conflicts with current state of the server

---

[API](https://skmtc.net/uberall/apis/uberall-api.md) · [All operations](https://skmtc.net/uberall/apis/uberall-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uberall/uberall-api/versions/a506e82d7cbe/schema)