---
title: "Preview (default) or apply several collections at once, conflict-aware"
method: POST
path: "/v1/sites/{siteId}/collections/plan"
tags: ["Collections"]
---

# Preview (default) or apply several collections at once, conflict-aware

`POST /v1/sites/{siteId}/collections/plan`

## 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/sites/{siteId}/collections/plan`
- Auth: HTTP bearer

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

## Path parameters

- `siteId` string, uuid, required

## Request body

- CollectionPlanRequest
  - `collections` object[], required
    - `slug` string
    - `name` string, required
    - `description` string, nullable
    - `templateKey` 'menu' | 'inventory' | 'events', nullable
    - `fields` CollectionField[]
      - `key` string: Stable; websites read values by it. Omit on new fields to derive it from the label.
      - `label` string, required
      - `type` 'short_text' | 'long_text' | 'number' | 'price' | 'date' | 'datetime' | 'toggle' | 'select' | 'multi_select' | 'image' | 'images' | 'link', required
      - `required` boolean
      - `helpText` string, nullable
      - `options` CollectionFieldOption[], nullable
        - `value` string, required
        - `label` string, required
      - `currency` string, nullable
      - `min` number, nullable
      - `max` number, nullable
    - `titleFieldKey` string
    - `visibility` 'public' | 'private'
    - `expectedSchemaVersion` integer
  - `dryRun` boolean: Defaults to true: returns the diff without saving.
  - `confirmDestructive` boolean

## Response `200`

Success

- CollectionPlanResult
  - `applied` boolean, required
  - `destructive` boolean, required
  - `summary` string, required: Plain-text diff to show before applying.
  - `results` object[], required
    - `slug` string, required
    - `name` string, required
    - `action` 'create' | 'update' | 'unchanged' | 'conflict', required
    - `collectionId` string, uuid, nullable, required
    - `changes` CollectionSchemaChange[], required
      - `kind` string, required
      - `fieldKey` string, nullable, required
      - `description` string, required
      - `destructive` boolean, required: Needs confirmDestructive: removes, converts, or renames something websites rely on.
      - `affectedItemCount` integer, required
    - `destructive` boolean, required
    - `schemaVersion` integer, nullable, required
    - `message` string, nullable, required

## Other responses

- `400`: Validation failed
- `401`: `INVALID_API_KEY`: missing, invalid, expired, or revoked key
- `403`: `INSUFFICIENT_SCOPE` (names the missing scope), `SITE_RESTRICTED_KEY`, or a plan limit
- `404`: Not found, or outside the key's sites
- `429`: Rate limited

---

[API](https://skmtc.dev/dropl/apis/dropl-public-api.md) · [All operations](https://skmtc.dev/dropl/apis/dropl-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dropl/apis/dropl-public-api/revisions/8a42e1f968d4?raw)