Syncs
Update sync settings
Sets the sync frequency: the longest a change may wait before it is synced (0 for real time).
Special Conditions: - 0 removes the stored delay (real time), so a sync set to 0 answers 0, as a sync never set does.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
base_id*stringThe sync.
uuidregion*RegionsThe region of the sync
"besg""usnv"application/json- body
max_records_sync_delay_in_seconds*Max Records Sync Delay In SecondsThe longest a change may wait before it is synced, in seconds; 0 syncs in real time
0 <= valueOK
application/json- response
PATCH /bases/<base_id>/settings
base_id*Base Idsettings*curl -X PATCH 'https://api.stacksync.com/v1/workspaces/0/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "max_records_sync_delay_in_seconds": 0}'{ "base_id": "<base_id>", "settings": { "max_records_sync_delay_in_seconds": 0 }}POSTCreate a sync
Create a sync between two apps from the tables and columns you pair with mapping ids. Stacksync reads both apps, checks every table and column, creates the tables marked `create_new_table` and stores the sync switched off: switch it on with the switch route. Send `validate_only: true` to run every check and get the sync as it would be stored without creating it.
PUTEdit a sync
Replace the mapping of a sync with the whole sync you send: read it, change tables, columns, directions, rate limits or delete protection, and send it back. A table left out of both apps is removed, a new pair is added. The sync is paused while the edit applies and restarted after it. Send `validate_only: true` to run every check without changing the sync.