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>"
  }
}
'
import requests

url = "https://api.squared.ai/api/v1/syncs/{id}"

payload = { "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>"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
}
})
};

fetch('https://api.squared.ai/api/v1/syncs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squared.ai/api/v1/syncs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.squared.ai/api/v1/syncs/{id}"

payload := strings.NewReader("{\n \"sync\": {\n \"source_id\": 123,\n \"destination_id\": 123,\n \"model_id\": 123,\n \"schedule_type\": \"<string>\",\n \"configuration\": {},\n \"stream_name\": \"<string>\",\n \"sync_mode\": \"<string>\",\n \"sync_interval\": 123,\n \"sync_interval_unit\": \"<string>\",\n \"cron_expression\": \"<string>\"\n }\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.squared.ai/api/v1/syncs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sync\": {\n \"source_id\": 123,\n \"destination_id\": 123,\n \"model_id\": 123,\n \"schedule_type\": \"<string>\",\n \"configuration\": {},\n \"stream_name\": \"<string>\",\n \"sync_mode\": \"<string>\",\n \"sync_interval\": 123,\n \"sync_interval_unit\": \"<string>\",\n \"cron_expression\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.squared.ai/api/v1/syncs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sync\": {\n \"source_id\": 123,\n \"destination_id\": 123,\n \"model_id\": 123,\n \"schedule_type\": \"<string>\",\n \"configuration\": {},\n \"stream_name\": \"<string>\",\n \"sync_mode\": \"<string>\",\n \"sync_interval\": 123,\n \"sync_interval_unit\": \"<string>\",\n \"cron_expression\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "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