Sync integration status
Triggers a manual sync for a specific integration and returns the current sync status.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (under Administrator) — Required to access Zenoti APIs.
Endpoint
POST /v1/integrations/{integration_id}/sync
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| integration_id | string (GUID) | Yes | Integration identifier |
Response
Success (200 OK)
{
"sync_id": "00000000-0000-0000-0000-05519edc7044",
"status": "In Progress",
"started_at": "2026-03-15T10:30:00",
"error": null
}
Response fields
| Field | Type | Description |
|---|---|---|
| sync_id | string (GUID) | Sync operation identifier |
| status | string | In Progress, Completed, Failed |
| started_at | datetime | Sync start time |
Example
curl --request POST \
--url 'https://api.zenoti.com/v1/integrations/00000000-0000-0000-0000-58d8cdab2cf3/sync' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/integrations/{integration_id}/sync', {
method: 'POST',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.post(
'https://api.zenoti.com/v1/integrations/{integration_id}/sync',
headers={
'Authorization': 'bearer {{access_token}}',
},
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PostAsync(
"https://api.zenoti.com/v1/integrations/{integration_id}/sync");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/integrations/{integration_id}/sync')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.zenoti.com/v1/integrations/{integration_id}/sync');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: bearer {{access_token}}'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
Error codes
| Status | Description |
|---|---|
| 401 | Unauthorized — invalid or expired access token |
| 404 | Resource not found |
| 429 | Too many requests — rate limit exceeded (60/min) |