See Stacksync in action with a solution architect. Book a demo ↗
StacksyncDocs
StacksyncCommunityBook a demoContact Support
HomeTwo-way syncAgentic WorkflowsGeniesEnterprise OSMCPEDIConnectorsSecurity and Other ResourcesChangelogDevelopersAPI Reference
Syncs

Syncs

Delete a sync

DELETE
/v1/workspaces/{workspace_id}/bases/{base_id}

Switch the sync off and delete it. Its data in both apps is kept; the sync's own storage is cleaned up in the background. The sync can no longer be read or listed.

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

The workspace the resources belong to

base_id*string

The sync (a sync is called a base in these paths)

Formatuuid

Query Parameters

region*string

Data region of the sync

Value in"besg""usnv"

Response Body

The sync deleted

application/json
  1. response

The deleted sync

data*

The deleted sync

Delete a sync
curl -X DELETE 'https://api.stacksync.com/v1/workspaces/0/bases/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg'
{  "data": {    "base_id": "3f6c1d2e-8a4b-4c7d-9e21-5b6f7a8c9d01"  }}

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.

POSTRename a sync

Change the name of a sync. The name must follow the name rule and be free in the workspace. Send `validate_only: true` to check the name without renaming.