---
title: "Start Bulk Sync Execution"
method: POST
path: "/api/bulk/syncs/{id}/executions"
tags: ["Bulk Sync"]
---

# Start Bulk Sync Execution

`POST /api/bulk/syncs/{id}/executions`

Starts a new execution of a bulk sync.

This endpoint returns the execution record immediately after the run is queued
or started. Use the execution ID with the bulk-sync execution endpoints if you
need to monitor progress in detail.

## Execution modes

- Set `test=true` to validate the sync without writing to the destination.
- Use `resync_mode` for destructive or full-refresh style reruns.
- `test` and `resync_mode` are mutually exclusive.

The legacy `resync` boolean is no longer accepted on this v5 endpoint. Send
`resync_mode` instead.

If another execution is already running, the endpoint returns `409 Conflict`.

## Path parameters

- `id` string, uuid, required — Unique identifier of the bulk sync.

## Headers

- `X-Polytomic-Version` string

## Request body

- StartBulkSyncRequest
  - `fetch_mode` 'none' | 'incremental' | 'full' — How the data is fetched. 'none' is normal operation for Polytomic. 'incremental' and 'full' apply to syncs from Salesforce. 'incremental' indicates the data is synced incrementally using record modification time. 'full' is necessary to catch up to the latest values for formula fields and rollup fields whose updates don't show up in incremental runs due to limitations in Salesforce.
  - `resync_mode` 'refetch' | 'resync' | 'rebuild'
  - `schemas` string[], nullable — Optional list of schema IDs to include in this execution. If empty, all enabled schemas are included.
  - `test` boolean — When true, runs a test execution that validates the configuration and syncs up to 5 records per schema. Mutually exclusive with resync_mode.

## Response `200`

OK

- BulkSyncExecutionEnvelope
  - `data` BulkSyncExecution
    - `completed_at` string, date-time, nullable
    - `created_at` string, date-time
    - `error_count` integer
    - `fetch_mode` 'none' | 'incremental' | 'full' — How the data is fetched. 'none' is normal operation for Polytomic. 'incremental' and 'full' apply to syncs from Salesforce. 'incremental' indicates the data is synced incrementally using record modification time. 'full' is necessary to catch up to the latest values for formula fields and rollup fields whose updates don't show up in incremental runs due to limitations in Salesforce.
    - `id` string, uuid
    - `is_partial` boolean
    - `is_resync` boolean
    - `is_test` boolean
    - `output_disposition` 'retain' | 'truncate' | 'rebuild'
    - `record_count` integer
    - `schemas` BulkSyncSchemaExecution[], nullable
      - `completed_at` string, date-time, nullable
      - `created_at` string, date-time
      - `error_count` integer
      - `output_name` string
      - `record_count` integer
      - `schema` string
      - `started_at` string, date-time, nullable
      - `status` 'created' | 'scheduled' | 'running' | 'exporting' | 'canceled' | 'completed' | 'failed' | 'interrupted' | 'processing'
      - `status_message` string
      - `updated_at` string, date-time
      - `warning_count` integer
    - `started_at` string, date-time, nullable
    - `status` 'created' | 'scheduled' | 'running' | 'exporting' | 'canceling' | 'canceled' | 'completed' | 'failed' | 'processing' | 'errors' | 'interrupted'
    - `status_message` string
    - `type` string
    - `updated_at` string, date-time
    - `warning_count` integer

## Other responses

- `400` — Bad Request
- `409` — Conflict

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/5e9bcd4cfb2d/schema)