Write syncs · writeSyncsDelete

Delete a write sync

Requires write-sync admin permission. Disables and soft-deletes the sync, releasing the relationship. Retains run history and record links; destination records are not deleted. In-flight writes may finish.

DELETE/v1/write-syncs/{writeSyncId}

betaapiKeyworkspace

When to use

Retire a sync and release its source/destination relationship.

For agents

Requires write-sync admin permission. Run history and record links remain, and destination records are not deleted. Requests already sent may finish.

Example

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.writeSyncs.delete('wsyn_contacts123');

Response

json

{
  "data": {
    "deleted": true
  }
}