Collections

Change name, slug, description, visibility, or the site time zone

Requires the collections:schema scope (create collections and change their fields (structure)).

patch/v1/collections/{collectionId}

Request

  • Base URL: https://api.dropl.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.dropl.io/v1/collections/{collectionId}
  • Auth: HTTP bearer

Path parameters

collectionIdstring uuid required

Request body

namestring
slugstring
descriptionstring nullable
visibility'public' | 'private'
timezonestring

IANA zone of the whole client site, e.g. America/Chicago.

Response

Success

idstring uuid required
publicIdstring required
workspaceIdstring uuid required
namestring required
slugstring required
descriptionstring nullable required
templateKey'menu' | 'inventory' | 'events' nullable required
visibility'public' | 'private' required
itemCountinteger required
publishedItemCountinteger required
titleFieldKeystring required
createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring date-time nullable required
purgeAfterstring date-time nullable required
lastPublicReadAtstring date-time nullable required
schemaVersioninteger required
timezonestring required
publicItemsUrlstring uri nullable required

Public read endpoint for websites (published items only); null when private.

canEditSchemaboolean required

Changes

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