PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List sites GETCreate a site POSTGet a site GETUpdate a site PATCHDelete a site DELETEPublish a site POSTUnpublish a site POSTList pages GETCreate a page POSTGet a page GETUpdate a page PATCHDelete a page DELETEList collections GETCreate a collection POSTGet a collection GETUpdate a collection PATCHDelete a collection DELETEList collection items GETCreate a collection item POSTGet a collection item GETUpdate a collection item PATCHDelete a collection item DELETEPublish collection items POSTUnpublish collection items POSTArchive collection items POSTUpsert collection items POST
Sites

Delete a collection

Deletes its items and template page. Fails while another collection has a reference field pointing at it.

DELETE
/sites/{siteId}/collections/{collectionId}

Deletes its items and template page. Fails while another collection has a reference field pointing at it.

Authorization

x-api-key<token>

In: header

Path Parameters

siteId*string
collectionId*string

Response Body

application/json

curl -X DELETE "https://example.com/sites/string/collections/string"
{  "data": {    "id": "string",    "deleted": true  }}

Update a collection PATCH

Send the full `fields` list. Removing a field keeps its stored values on items. `jsonLd` null removes it.

List collection items GET

Drafts included. `search` matches name or slug.