2024-02-08
Search...
/
Log in
Book a demo
Guides
API Reference
Guides
API Reference
API Reference
Bulk Sync
GET
List Bulk Syncs
POST
Create Bulk Sync
GET
Get Bulk Sync
PUT
Update Bulk Sync
DEL
Remove Bulk Sync
POST
Activate Bulk Sync
POST
Start Bulk Sync Execution
GET
Get Bulk Sync Status
GET
Get Bulk Source
GET
Get Bulk Destination
Executions
GET
List Bulk Sync Execution Status
GET
List Bulk Sync Executions
GET
Get Bulk Sync Execution
GET
Get Bulk Sync Execution Logs
POST
Export Sync Logs
Schemas
GET
Get Bulk Sync Schemas
PATCH
Update Bulk Sync Schemas
GET
Get Bulk Sync Schema
PUT
Update Bulk Sync Schema
Connections
GET
Get Connection Types
GET
List Connections
POST
Create Connection
POST
Connect
GET
Get Connection
PUT
Update Connection
DEL
Remove Connection
GET
Connection Parameter Values
Query Runner
POST
Run Query
GET
Get Query Results
Models
GET
Get Enrichment Source
POST
Enrichment Fields
POST
Preview Model
GET
List Models
POST
Create Model
GET
Get Model
PUT
Update Model
DEL
Remove Model
GET
Sample Records
Model Sync
GET
Get Sync Source
GET
Model Sync Field Query
GET
Get Sync Target
GET
Get Sync Target Fields
GET
Get Sync Target Objects
GET
List Syncs
POST
Create Sync
GET
Get Sync Schedule Options
GET
Get Sync
PUT
Update Sync
DEL
Remove Sync
POST
Activate Sync
POST
Start Sync
GET
Get Sync Status
Executions
GET
List Executions
GET
Get Execution
GET
Get Execution Log Urls
GET
Get Execution Log
Schemas
POST
Refresh Connection Schema
GET
Get Schema Status
GET
Get Schema
GET
Get Schema Records
Events
GET
Get Events
GET
Get Event Types
Jobs
GET
Get Job
Identity
GET
Get Identity
Organization
GET
Get Organizations
POST
Create Organization
GET
Get Organization
PUT
Update Organization
DEL
Remove Organization
Users
GET
List Users
POST
Create User
GET
Get User
PUT
Update User
DEL
Remove User
POST
Create API Key
Permissions
Policies
GET
List Policies
POST
Create Policy
GET
Get Policy
PUT
Update Policy
DEL
Delete Policy
Roles
GET
List Roles
POST
Create Role
GET
Get Role
PUT
Update Role
DEL
Delete Role
Webhooks
GET
List Webhooks
POST
Create Webhook
GET
Get Webhook
PUT
Update Webhook
DEL
Delete Webhook
Log in
Book a demo
API Reference
Model Sync
Create Sync
POST
https://
app.polytomic.com
/
api
/
syncs
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 9 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
422
Unprocessable Entity
500
Internal Server Error