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

Upsert collection items

Creates or updates items by `slug`. Existing items keep fields a row leaves out and keep their status; new items are drafts; nothing is published. Up to 200 rows run inline; more return a `jobId` to poll with `GET /jobs/{jobId}`.

POST
/sites/{siteId}/collections/{collectionId}/upsert

Creates or updates items by slug. Existing items keep fields a row leaves out and keep their status; new items are drafts; nothing is published. Up to 200 rows run inline; more return a jobId to poll with GET /jobs/{jobId}.

Authorization

x-api-key<token>

In: header

Path Parameters

siteId*string
collectionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/sites/string/collections/string/upsert" \  -H "Content-Type: application/json" \  -d '{    "rows": [      {        "slug": "string",        "data": {          "name": "string"        }      }    ]  }'
{  "data": {    "kind": "inline",    "created": 0,    "updated": 0,    "failed": [      {        "row": 0,        "slug": "string",        "message": "string"      }    ]  }}

Archive collection items POST

Hides items and takes them off the live site. Archiving live items needs site publish permission.

rows*array<>
Items1 <= items <= 20000