# set_sync_paused

Behavior, inputs, outputs and permissions for set_sync_paused.

Source: https://docs.getridian.com/developers/tools/set_sync_paused/
Language: en
Reviewed: 2026-10-06

This reference is generated from the published tool contract.

## Behavior and boundaries

Sets whether one of the user's own sync pairs is paused. This sets a state; it does not toggle one, so asking to pause an already paused sync leaves it paused. Both directions of a two-way pair are affected together. Pausing keeps existing copies in the target calendar and only stops further syncing; it never deletes anything. Resuming allows the sync engine to update and remove managed target copies as source events change. A pair that is being deleted is left alone. Use a ref from a current list_syncs result.

## 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](https://docs.getridian.com/developers/authentication/)

## Input

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

## Output

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "const": true
    },
    "legs": {
      "type": "number"
    },
    "paused": {
      "type": "boolean"
    }
  },
  "required": [
    "ok",
    "legs",
    "paused"
  ],
  "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](https://docs.getridian.com/developers/errors/)