---
title: "Stop the running sync for a connector"
method: POST
path: "/connectors/{connectorId}/sync/stop"
tags: ["Connector Instances"]
---

# Stop the running sync for a connector

`POST /connectors/{connectorId}/sync/stop`

## Request

- Base URL: `https://app.pipeshub.com/api/v1`
- URL: `https://app.pipeshub.com/api/v1/connectors/{connectorId}/sync/stop`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `/api/v1/oauth2/authorize`
    - Client credentials
    - Token URL: `/api/v1/oauth2/token` scopes: `connector:sync`

Ask the in-flight sync for a connector instance to stop.

**Overview:**

Returns as soon as the request is recorded; the sync halts at its next
interruptible point, which for a connector inside a long provider call
is when that call returns. `stopped` reports whether a sync was actually
running, and `false` is a normal answer rather than a failure.

Deliberately not refused while the connector is busy or locked: this is
the endpoint that has to work precisely then, including against a lock a
crashed process left behind. When nothing is running it also repairs a
stale SYNCING or FULL_SYNCING status, unless the service cannot tell a
live sync on another worker from a stale one, in which case it changes
nothing and says so.

## Path parameters

- `connectorId` string, required

## Response `200`

Stop recorded, or nothing was running

- object
  - `success` boolean, required
  - `stopped` boolean, required: Whether a sync was running and has been asked to stop. False is a normal answer, not an error.
  - `status` 'IDLE' | 'SYNCING' | 'FULL_SYNCING' | 'QUEUED' | 'DELETING', required: The status the connector is actually left in.
  - `message` string, required

## Other responses

- `400`: The connector ID is not 1-64 letters, digits, `_` or `-` (`VALIDATION_ERROR`), or it decodes to an unsafe path segment (refused before the token is checked).
- `401`: Missing or invalid credentials
- `403`: Insufficient scope (connector:sync is required). Also returned for an instance of a beta connector type (Calendar, Meet, Forms, Slides, Docs, Zendesk, Airtable) while the platform feature flag `ENABLE_BETA_CONNECTORS` is off (the default), with the message `Beta connectors are not enabled. The connector '<type>' is a beta connector and cannot be accessed. ...`
- `404`: Connector instance not found or not accessible. A team connector of another user is answered `404` to a member, as if it did not exist.
- `500`: The stop could not be recorded. A JSON body larger than 10 MB, or a form-encoded body larger than 100 KB or with more than 1000 fields, is answered `413` by the app-wide body parsers instead, also before authentication.

## Changes

- **2026-10-28** `dbb5e203b445`: 2 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `500`
- **2026-10-15** `a44792e4f0e6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/changes/connectors/:connectorId/sync/stop/post.md)

---

[API](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api.md) - [All operations](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pipeshub-ai/apis/pipeshub-api/revisions/dbb5e203b445?raw)