Skip to navigation
Experience Management APIDesign libraries

Update a design library

Updates a design library.

Update the library from its source space. Include its current sys.version in X-Contentful-Version to lock against concurrent edits.

Update requirements:

  • Supply all four editable fields: name, description, sharedWithSpaces and recommendedVersion, including unchanged values.
  • The source environment and taxonomy concept cannot be changed.
  • Set description or recommendedVersion to null to clear it.
  • A recommended version must belong to this library and have status succeeded.

Authentication

AuthorizationBearer
Contentful Management API token

Path parameters

designLibraryIdstringRequired
spaceIdstringRequired

Headers

X-Contentful-VersionstringRequiredformat: "^[1-9][0-9]*$"

The design library’s current sys.version, as a decimal integer from 1 to 2147483647.

Request

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

A description of up to 1,000 characters. Set it to null to clear the current description.

sharedWithSpaces"*" or list of stringsRequired

Replaces the sharing settings for spaces in the same organisation:

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

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

recommendedVersionobject or nullRequired

A link to a succeeded version of this design library. Set it to null to clear the recommendation.

Response

200
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