Skip to main content

Update Content Sync Settings

PUT 
/api/integration-instances/:integrationInstance/content-sync-settings

Update the instance-level content-sync configuration. Partial updates are merged onto the current settings, so only the keys you send change — but enabled is required on every request. Enabling sync for the first time starts a background baseline job over every mapped listing on the instance, so pre-existing differences are not flagged as drift on day one; poll the jobs API to watch it complete.

Required scope: integrations:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

reconcile_frequency: six_hours, daily, weekly, or manual. manual switches off the scheduled sweep for this instance — drift is still detected in real time from channel webhooks, and a comparison can be triggered on demand through the reconcile endpoint. Ownership values: catalog (channel edits are flagged only), channel (channel edits can be pulled into the catalog), two_way (both sides may edit; simultaneous edits become conflicts). governance_gate.enabled: hold products back from publishing to this channel until their catalog content is complete. Outbound publishing only — inbound content is never blocked. governance_gate.require: the fields that must be present before a product may publish. Accepted values: barcode, mpn, name, brand, attributes, images, weight, dimensions. An enabled gate with an empty require list lets every product through. The governance gate is evaluated independently of enabled, so it still applies when ongoing drift detection is switched off. Unknown group, field, or required-field keys are rejected with a 422. Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type