Create a Sync Document
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/sync/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"unique_name": "<string>",
"data": {},
"ttl": 15768000
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/sync/documents"
payload = {
"unique_name": "<string>",
"data": {},
"ttl": 15768000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({unique_name: '<string>', data: {}, ttl: 15768000})
};
fetch('https://api.orbit.devotel.io/api/v1/sync/documents', 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.orbit.devotel.io/api/v1/sync/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'unique_name' => '<string>',
'data' => [
],
'ttl' => 15768000
]),
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.orbit.devotel.io/api/v1/sync/documents"
payload := strings.NewReader("{\n \"unique_name\": \"<string>\",\n \"data\": {},\n \"ttl\": 15768000\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/sync/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"unique_name\": \"<string>\",\n \"data\": {},\n \"ttl\": 15768000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/sync/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"unique_name\": \"<string>\",\n \"data\": {},\n \"ttl\": 15768000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"unique_name": "<string>",
"data": {},
"revision": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Sync
Create a Sync Document
Create a durable Sync Document — a single JSON object addressed by a unique name, with a monotonic revision. Supply unique_name, an optional initial data object, and an optional ttl (seconds, 0 = no expiry). Requires an operator role (owner / admin / developer / agent).
POST
/
api
/
v1
/
sync
/
documents
Create a Sync Document
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/sync/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"unique_name": "<string>",
"data": {},
"ttl": 15768000
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/sync/documents"
payload = {
"unique_name": "<string>",
"data": {},
"ttl": 15768000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({unique_name: '<string>', data: {}, ttl: 15768000})
};
fetch('https://api.orbit.devotel.io/api/v1/sync/documents', 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.orbit.devotel.io/api/v1/sync/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'unique_name' => '<string>',
'data' => [
],
'ttl' => 15768000
]),
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.orbit.devotel.io/api/v1/sync/documents"
payload := strings.NewReader("{\n \"unique_name\": \"<string>\",\n \"data\": {},\n \"ttl\": 15768000\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.orbit.devotel.io/api/v1/sync/documents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"unique_name\": \"<string>\",\n \"data\": {},\n \"ttl\": 15768000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/sync/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"unique_name\": \"<string>\",\n \"data\": {},\n \"ttl\": 15768000\n}"
response = http.request(request)
puts response.read_body{
"data": {
"unique_name": "<string>",
"data": {},
"revision": 123,
"date_created": "2023-11-07T05:31:56Z",
"date_updated": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Tenant-unique name for the new document.
Required string length:
1 - 256Pattern:
^[A-Za-z0-9._:-]+$Arbitrary JSON object payload carried by a Sync object or item. Every Sync value is a JSON map (matching Twilio Sync). The serialised payload must not exceed 64 KiB.
Optional time-to-live in seconds (0 or omitted = no expiry).
Required range:
0 <= x <= 31536000⌘I