---
title: "Create new layout mappings."
method: POST
path: "/authoring/v1/layout-mappings"
tags: ["Authoring layouts"]
---

# Create new layout mappings.

`POST /authoring/v1/layout-mappings`

Use the /layout-mapping end-point to create a new layout mapping.<br />User roles: admin, manager

## Request body

- object — A new layout mapping.
  - `name` string, required — The name of the layout mapping.
  - `classification` 'layout-mapping' — Indicates the type of this document.
  - `created` string, date-time — Optional creation date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. Value is ignored if set in the future.
  - `path` string — Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
  - `tags` string[]
  - `type` object, required — The mapped content-type. Must be unique. During create and update operations, the mapped content-type can be referred to by either id or name.
    - `id` string — The ID of the mapped content-type.
    - `name` string — The name of the mapped content-type. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.
  - `mappings` object[], required — The mapped layouts.
    - `defaultLayout` object, required — an individual layout reference.
      - `id` string, required — The ID of the referenced layout.
      - `name` string — The name of the referenced layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.
    - `layouts` object[], required — The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
      - `id` string, required — The ID of the referenced layout.
      - `name` string — The name of the referenced layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.
  - `isSystem` boolean — Indicates whether this item is a 'system item' or not.

## Response `201`

Success.

- object — An existing layout mapping.
  - `id` string — The ID of the layout mapping.
  - `rev` string, required — The current revision of the layout mapping.
  - `name` string, required — The name of the layout mapping.
  - `classification` 'layout-mapping' — Indicates the type of this document.
  - `creatorId` string — The ID of the user that created the layout mapping.
  - `creator` string — The display name of the user that created the layout mapping. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.
  - `created` string, date-time — The created date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
  - `lastModifierId` string — The ID of the user that last modified the layout mapping.
  - `lastModifier` string — The display name of the last user that modified the layout mapping. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.
  - `lastModified` string, date-time — The last modified date of this layout mapping in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.
  - `path` string — Optional path to associate with the layout mapping. Must be unique. Will default to filesystem friendly version of /[NAME].
  - `tags` string[]
  - `type` object, required — The mapped content-type. Must be unique. During create and update operations, the mapped content-type can be referred to by either id or name.
    - `id` string — The ID of the mapped content-type.
    - `name` string — The name of the mapped content-type. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.
  - `mappings` object[], required — The mapped layouts.
    - `defaultLayout` object, required — an individual layout reference.
      - `id` string, required — The ID of the referenced layout.
      - `name` string — The name of the referenced layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.
    - `layouts` object[], required — The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)
      - `id` string, required — The ID of the referenced layout.
      - `name` string — The name of the referenced layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'. This field is read only.
  - `isSystem` boolean — Indicates whether this item is a 'system item' or not.

## Other responses

- `400` — Empty body or Invalid input.
- `403` — The operation is not available based on the current tenant's tier.
- `404` — Current tenant's database is not provisioned.
- `409` — A layout mapping associated with the same content-type OR path exists.
- `429` — Too Many Requests, the server has reached a limit, the request must be sent again at a later time.
- `500` — Unexpected error.

---

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