Collection Properties

Update Collection Properties

Allows a user to update the properties on a collection. This endpoint uses the supplied values to either update existing properties or add new properties.

patch/collections/{collectionId}/properties

Request

  • Base URL
    https://data.lucid.app
  • URL
    https://data.lucid.app/collections/{collectionId}/properties
  • Auth
    OAuth 2
    Authorization code: https://lucid.app/oauth2/authorize
    Token URL: https://api.lucid.co/oauth2/token scopes: data-service.admin

Path parameters

collectionIdinteger required

ID of collection to update properties for

Request body

object required

The properties field takes an object of key-value pairs

Example request

{
  "backgroundColor": "blue",
  "font": "Times New Roman"
}

Response

OK with Map[String,JsValue] of properties on the specified collection

object required

Example response

{
  "backgroundColor": "blue",
  "font": "Times New Roman"
}

Changes

No recorded changes to this operation across all 1 revision of this API.