Start Bulk Sync Execution

curl -X POST https://app.polytomic.com/api/bulk/syncs/248df4b7-aa70-47b8-a036-33ac447e668d/executions \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -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",
        "warning_count": 0
      }
    ],
    "started_at": "2023-04-25T12:00:00Z",
    "status": "created",
    "status_message": "string",
    "type": "scheduled",
    "updated_at": "2023-04-25T12:00:00Z",
    "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.

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

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the bulk sync.

Request

This endpoint expects an object.

fetch_modeenumOptional

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.

Allowed values:

resync_modeenumOptional

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 without writing to the destination. Mutually exclusive with resync and resync_mode.

resyncbooleanOptionalDeprecated

Deprecated: use resync_mode instead. Equivalent to resync_mode=rebuild.

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error

Execution modes

Authentication

Path parameters

Headers

Request

Response

Errors

Execution modes

Authentication

Path parameters

Headers

Request

Response

Errors