Update Collection

Update an existing collection

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Only the collection settings can be updated with this endpoint. Updating a field of a collection can be done with the Fields API documented below

🚧

External endpoint content type

The URL specified in the external_endpoint property of the external details object, must return a Content-Type header set to application/json other content types will cause an error when creating the collection.

🚧

When changing external details, you should include all existing properties. Any missing properties in your request, will be deleted from the collection configuration.

Path Params
string
required

A valid site name of an existing website

string
required

Name of the current collection

Body Params
string
enum
Defaults to unlocked

The lock state of the collection. Must be one of unlocked, structure_locked or locked

Allowed:
external_details
object
string

The new name of the collection (must not start with $)

boolean
Defaults to false

Allows collection data to be connected to widgets on a non-dynamic page.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json