POpolytomic
Bulk Sync

Start Bulk Sync Execution

Changed on

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.

post/api/bulk/syncs/{id}/executions

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the bulk sync

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

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'
schemasstring[] nullable

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

testboolean

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

Response

OK

Example response

{
  "data": {
    "completed_at": "2023-04-25T12:00:00Z",
    "created_at": "2023-04-25T12:00:00Z",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "record_count": 1000,
    "schemas": [
      {
        "completed_at": "2023-04-25T12:00:00Z",
        "created_at": "2023-04-25T12:00:00Z",
        "output_name": "contact",
        "record_count": 1000,
        "schema": "contact",
        "started_at": "2023-04-25T12:00:00Z",
        "updated_at": "2023-04-25T12:00:00Z",
        "version": "rel2026.08.05.06~1a2b3c4"
      }
    ],
    "started_at": "2023-04-25T12:00:00Z",
    "type": "scheduled",
    "updated_at": "2023-04-25T12:00:00Z",
    "version": "rel2026.08.05.06~1a2b3c4"
  }
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      removed the enum value full of the request property

    • breaking

      removed the enum value incremental of the request property

    • breaking

      removed the enum value none of the request property

    • breaking

      removed the enum value rebuild of the request property

    • breaking

      removed the enum value refetch of the request property

    • breaking

      removed the enum value resync of the request property

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • a4c3b8f8eff7Revision changes
    • warning

      added the new completed_with_cancellations enum value to the / response property for the response status