Skip to main content
POST
Create a provider snapshot upload

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

sync_id
string
required

Configured source sync receiving the page.

Minimum string length: 1

Body

application/json

One completed provider bulk operation ready for streaming handoff.

source_operation_id
string
required

Stable provider operation or fanout-manifest identifier used to make snapshot creation idempotent.

Required string length: 1 - 255
source_format
enum<string>
required

Versioned provider export format; selects parsing and REPLACE or UPSERT mutation mode.

Available options:
SHOPIFY_GRAPHQL_JSONL_2026_01,
SALESFORCE_BULK_CSV_2026_09,
SALESFORCE_BULK_CSV_UPSERT_2026_09
expected_size_bytes
integer
required

Exact bulk-result byte size, or zero when staged pages supply the authoritative manifest.

Required range: 0 <= x <= 9007199254740991
sync_generation
string
required

Current installed recipe generation; stale generations cannot create or commit a snapshot.

Required string length: 1 - 255
staged_pages
boolean
default:false

Whether the snapshot is assembled from immutable numbered pages instead of one direct upload.

Response

Successful Response

data
SnapshotCreateResponseData · object
required

Provider snapshot creation result.