Start Bulk Sync Execution

POST

https://app.polytomic.com/api/bulk/syncs/:id/executions

POST

/api/bulk/syncs/:id/executions

curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "data": {
    "completed_at": "2023-04-25T12:00:00Z",
    "created_at": "2023-04-25T12:00:00Z",
    "error_count": 0,
    "fetch_mode": "none",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "is_partial": false,
    "is_resync": false,
    "is_test": false,
    "output_disposition": "retain",
    "record_count": 1000,
    "schemas": [
      {
        "completed_at": "2023-04-25T12:00:00Z",
        "created_at": "2023-04-25T12:00:00Z",
        "error_count": 0,
        "output_name": "contact",
        "record_count": 1000,
        "schema": "contact",
        "started_at": "2023-04-25T12:00:00Z",
        "status": "created",
        "status_message": "string",
        "updated_at": "2023-04-25T12:00:00Z",
        "version": "rel2026.08.05.06~1a2b3c4",
        "warning_count": 0
      }
    ],
    "started_at": "2023-04-25T12:00:00Z",
    "status": "created",
    "status_message": "string",
    "type": "scheduled",
    "updated_at": "2023-04-25T12:00:00Z",
    "version": "rel2026.08.05.06~1a2b3c4",
    "warning_count": 0
  }
}

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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync

Request

This endpoint expects an object.

fetch_modeenumOptional

Selective fetch mode. Controls whether the execution runs a full fetch, only incremental fields, or only non-incremental fields.

Allowed values:

resync_modeenumOptional

Controls how the destination is handled during a resync. Valid values: refetch (retain destination data), resync (truncate destination data), rebuild (drop and recreate destination tables).

Allowed values:

schemaslist of strings or nullOptional

Optional list of schema IDs to include in this execution. If empty, all enabled schemas are included.

testbooleanOptional

When true, runs a test execution that validates the configuration and syncs up to 5 records per schema. Mutually exclusive with resync_mode.

Response

dataobjectOptional

The bulk sync execution

Errors

400

Bad Request Error

409

Conflict Error