2023-04-25
Search...
/
Log in
Book a demo
Getting started
Introduction
Obtaining API keys
Quickstart
Native clients
Concepts
Embedding authentication
Versioning
Idempotent requests
Events
Configuring your connections
CDC streaming from databases
Connection configurations
Code examples
Bulk sync (ELT) from HubSpot to PostgreSQL
Bulk sync (ELT) from Salesforce to S3
Bulk sync (ELT) from Salesforce to Snowflake
Model sync (Reverse ETL) from MongoDB to Salesforce
API Reference
Bulk Sync
Connections
Schemas
Models
Events
Jobs
Identity
Organization
Users
Permissions
Model Sync
GET
List Syncs
POST
Create Sync
GET
Get Sync Schedule Options
GET
Get Sync
DEL
Remove Sync
PATCH
Update Sync
POST
Activate Sync
POST
Start Sync
GET
Get Sync Status
Executions
Webhooks
Log in
Book a demo
API Reference
Model Sync
Update Sync
PATCH
https://app.polytomic.com
/
api
/
syncs
/
:id
Path parameters
id
string
Required
Request
This endpoint expects an object.
fields
list of objects
Required
Fields to sync from source to target.
Show 5 properties
mode
string
Required
name
string
Required
schedule
object
Required
Show 10 properties
target
object
Required
Show 6 properties
active
boolean
Optional
enricher
object
Optional
Show 5 properties
filter_logic
string
Optional
filters
list of objects
Optional
Either
field
or
field_id
must be provided. If
field
is provided,
field_id
is ignored.
Show 6 properties
identity
object
Optional
Show 5 properties
organization_id
string
Optional
override_fields
list of objects
Optional
Values to set in the target unconditionally.
Show 5 properties
overrides
list of objects
Optional
Conditional value replacement for fields.
Show 5 properties
policies
list of strings
Optional
sync_all_records
boolean
Optional
Response
This endpoint returns an object.
data
object
Optional
Show 15 properties
Errors
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
422
Unprocessable Entity
500
Internal Server Error