delete_sync

This reference is generated from the published tool contract.

Behavior and boundaries

Deletes one of the user’s own sync pairs, both directions of a two-way pair, like deleting it in Ridian. Call preview_delete_sync first, tell the user how many managed copies will be removed from the target calendar(s), and pass its confirmToken after the user confirmed. Ridian removes its copies in the background; the original events stay. If the pair changed since the preview, nothing is deleted and you need a new preview. Cannot be undone.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

sync:write

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ref": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "confirmToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  },
  "required": [
    "ref",
    "confirmToken"
  ],
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "status": {
      "type": "string",
      "const": "deleting"
    },
    "legs": {
      "type": "number"
    },
    "copiesToRemove": {
      "type": "number"
    }
  },
  "required": [
    "ok",
    "status",
    "legs",
    "copiesToRemove"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling