Skip to navigation
Experience Management APIDesign libraries

Create a design library

Creates a design library from a source environment and taxonomy concept in the specified space.

Creating a design library does not create a version. Use Create a design library version to snapshot its items.

Item selection

The taxonomy concept in basedOn.concept selects the components, design tokens and experience templates to include in future versions. Related data assemblies are included automatically; content types and editor interfaces can be included when creating a version.

See How items are included.

Authentication

AuthorizationBearer
Contentful Management API token

Path parameters

spaceIdstringRequired

Request

Body
namestringRequired1-256 characters
descriptionstring or nullRequired<=1000 characters

A description of up to 1,000 characters, or null for no description. This field is required.

basedOnobjectRequired
Links to the source environment in this space and the taxonomy concept used to select the library's items.
sharedWithSpaces"*" or list of stringsRequired

Controls which spaces in the same organisation can read and install the library:

  • An array of space IDs: Share with those spaces.
  • "*": Share with all spaces in the organisation.
  • An empty array: No sharing.

Explicit space IDs must contain 12 lowercase letters or digits and must exclude the source space.

Response

201
sysobject
namestring
descriptionstring or null
sharedWithSpaces"*" or list of strings
recommendedVersionobject or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error