Collection Object


Properties
idstringRead-onlyformat GUID

Collection ID.


revisionintegerRead-onlyformat uint64

Revision number, which increments by 1 each time the collection is updated. To prevent conflicting changes, the existing revision must be passed when updating the collection object.


titlestringmaxLength 100

Collection title.


descriptionstring

Collection description.


slugstring

Collection slug.


coverImageCoverImage

Collection cover image.


hiddenboolean

Whether the collection is hidden from the portfolio. Default: false


sortOrdernumberformat double

Index that determines which position a collection is displayed in the portfolio.

Default: Epoch timestamp.


createdDatestringRead-onlyformat date-time

Date and time the collection was created.


updatedDatestringRead-onlyformat date-time

Date and time the collection was updated.


urlUrlRead-only

Collection page URL and and relative path. Returned when includePageUrl is true in the request.


seoDataSeoData

Collection SEO data.

Did this help?