Skip to main content
PATCH
Update a collection

Authorizations

x-api-key
string
header
required

Enter your API key

Path Parameters

collectionId
string
required

Collection ID

Example:

"507f1f77bcf86cd799439011"

Body

application/json
name
string

Name of the collection

Minimum string length: 1
Example:

"Getting Started Guide"

description
string

Description of the collection

Minimum string length: 1
Example:

"Learn how to get started with our platform"

icon
string

Icon identifier for the collection

Minimum string length: 1
Example:

"book"

isProtected
boolean

Whether the collection requires authentication to access

Example:

false

meta
object

Meta information for SEO

Example:

Response

Collection updated successfully.

data
object
required
message
string
required
Example:

"Collection updated successfully."