Skip to main content
PUT
/
api
/
v1
/
syncs
/
{id}
Update a specific sync operation
curl --request PUT \
  --url https://api.squared.ai/api/v1/syncs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sync": {
    "source_id": 123,
    "destination_id": 123,
    "model_id": 123,
    "schedule_type": "<string>",
    "configuration": {},
    "stream_name": "<string>",
    "sync_mode": "<string>",
    "sync_interval": 123,
    "sync_interval_unit": "<string>",
    "cron_expression": "<string>"
  }
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "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.

Path Parameters

​
id
string
required

Body

application/json
​
sync
object

Response

200 - application/json

Sync operation updated successfully

​
success
boolean
​
message
string
​
data
object