Skip to main content
POST
/
api
/
v1
/
syncs
Create a new sync operation
curl --request POST \
  --url https://api.squared.ai/api/v1/syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sync": {
    "source_id": 123,
    "destination_id": 123,
    "model_id": 123,
    "schedule_type": "automated",
    "configuration": {},
    "stream_name": "<string>",
    "sync_mode": "full_refresh",
    "sync_interval": 123,
    "sync_interval_unit": "minutes",
    "cron_expression": "<string>",
    "cursor_field": "<string>"
  }
}'
{
  "id": "<string>",
  "type": "syncs",
  "attributes": {
    "source_id": 123,
    "destination_id": 123,
    "model_id": 123,
    "configuration": {},
    "schedule_type": "automated",
    "sync_mode": "full_refresh",
    "sync_interval": 123,
    "sync_interval_unit": "minutes",
    "cron_expression": "<string>",
    "cursor_field": "<string>",
    "stream_name": "<string>",
    "status": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sync
object

Response

200 - application/json

Sync operation created successfully

​
id
string
​
type
enum<string>
Available options:
syncs
​
attributes
object