---
title: "Create Collection"
method: POST
path: "/sites/multiscreen/{site_name}/collection"
---

# Create Collection

`POST /sites/multiscreen/{site_name}/collection`

Create a new collection within a site

## Path parameters

- `site_name` string, required

## Request body

- object
  - `customer_lock` 'unlocked' | 'structure_locked' | 'locked' — The lock state of the collection. Must be one of `unlocked`, `structure_locked` or `locked`
  - `external_details` object
    - `authorization_header_value` string — Value to be sent in the Authorization header. This value should include the authorization scheme e.g., `Basic` or `Bearer`.
    - `collection_data_json_path` string — Path to the root of the collection data within the collection endpoint response. If no path is provided the entire response will be used as collection data. The value can use dot or bracket notation e.g., `object.property` or `['object'].['property']`
    - `custom_headers` object[] — Array of custom headers to be sent along with the data request from Duda.
      - `name` string, required
      - `values` string[], required
    - `enabled` boolean — A boolean flag to specify the collection as external (true) vs. an internal (false) collection.
    - `external_endpoint` string — An absolute URI pointing to the data for the collection.
    - `external_id` string — Value that can be used to revalidate the collection cache without using a site alias.
    - `page_item_url_field` string — The name of a field in the collection. The value of this field will be used to generate the URL slug for dynamic pages generated by this collection. The values contained in this field should not exceed 350 characters - excess characters will be trimmed from the URL.
  - `fields` object[], required — You must define at least one field when creating a collection.
    - `multi_select_options` string[] — If the type is "multi_select"
    - `name` string — The name of the collection field. (must not start with $)
    - `type` string — The data type for this field
    - `single_select_options` string[] — If the type is "single_select"
  - `name` string, required — The name of the collection (must not start with $)
  - `static_page_bindable` boolean — Allows collection data to be connected to widgets on a non-dynamic page.
  - `base_refresh_interval` string — Update Frequency can control how often external collections refresh.

## Response `204`

204

## Other responses

- `400` — 400

---

[API](https://skmtc.net/duda/apis/partner-api.md) · [All operations](https://skmtc.net/duda/apis/partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/duda/partner-api/revisions/5b9208270ed1/schema)