---
title: "Preview a bulk upsert (dry run)"
method: POST
path: "/v1/records/{object}/bulk-upsert/preview"
---

# Preview a bulk upsert (dry run)

`POST /v1/records/{object}/bulk-upsert/preview`

## Request

- Base URL: `https://api.pantheon.run`
- URL: `https://api.pantheon.run/v1/records/{object}/bulk-upsert/preview`
- Auth: HTTP bearer

The exact plan POST …/bulk-upsert would execute; writes nothing. Needs only read access.

## Path parameters

- `object` string, required

## Request body

- object
  - `match_on` unknown
  - `mode` unknown
  - `on_match` unknown
  - `records` unknown

## Response `200`

Default Response

- object
  - `dry_run` boolean
  - `duplicate_check` string
  - `results` object[]
    - `candidates` string[]
    - `conflicts` object[]
      - `current` unknown
      - `field` string
      - `incoming` unknown
    - `error` object
      - `code` string
      - `details` unknown
      - `message` string
    - `filled` string[]
    - `id` string
    - `index` integer
    - `matched_by` string
    - `of_index` integer
    - `reason` string
    - `status` string
  - `summary` object

---

[API](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api.md) · [All operations](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pantheon-run/apis/pantheon-developer-api/revisions/e51924bd212a?raw)