Initiate sync
Triggers a synchronization process to push pending changes to all door controllers.
This endpoint initiates the sync if there are unsynced changes in the account.
The sync process is rate-limited to prevent excessive sync requests.
/api/3/sync
Authentication
This endpoint requires authentication:
Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.
Header Format:
Authorization: Bearer YOUR_ACCESS_TOKEN
Required Scopes:
account.sync
Responses
Sync initiated successfully (or no changes to sync)
Response Fields
result
string
eg. ok
Unauthorized - Invalid or missing authentication
Response Fields
error
string
eg. unauthorized
error_description
string
eg. The access token is invalid
Forbidden - User does not have permission
Response Fields
error
string
eg. forbidden
error_description
string
eg. You are not authorized to access this resource
Too Many Requests - Sync rate limit exceeded
Response Fields
error
string
required
Error code indicating rate limiting
eg. rate_limited
description
string
required
Human-readable description of the rate limit
eg. Sync rate limit exceeded. Please wait before trying again.
retry_in
integer
required
Number of seconds to wait before retrying
eg. 60
Internal Server Error
Response Fields
error
string
eg. internal_server_error
error_description
string
eg. An unexpected error occurred