Stop sync job

Stops a running sync job and cancels pending tasks

DELETE/v1/apps/{app_id}/integrations/{integration_id}/sync/{sync_id}

API: Integrations
OpenAPI: integrations-api
Updated: Apr 26, 2026

integrations-api:DELETE:/v1/apps/{app_id}/integrations/{integration_id}/sync/{sync_id}

Stops a running sync job and cancels pending tasks

API ownership

API family: Integrations API
Best for: Integration records, setup verification, app and integration stats, and sync job operations.
Do not use from: Direct catalog, media, order, identity, or storefront reads and writes.
Guide route: /integrations

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: DELETE
Path: /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync/\{sync_id\}
Summary: Stop sync job
Description: Stops a running sync job and cancels pending tasks
OpenAPI contract: integrations-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters

Name	In	Required	Type	Description
app_id	path	Yes	string	App UUID
integration_id	path	Yes	string	Integration UUID
sync_id	path	Yes	string	Sync UUID

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses3 statuses

Status	Description	Content
200	Sync job stopped	application/json
400	Invalid request	application/json (object)
500	Internal server error	application/json (object)

200 - object

Schema

Property	Type	Required	Details
`data`	object	No	-
`success`	boolean	No	-

Stop Sync

Property	Type	Required	Details
`jobs_cancelled`	integer	No	-
`remaining_jobs`	object	No	-
`sync_id`	string	No	-

Remainings Jobs

Property	Type	Required	Details
`completed`	integer	No	-
`failed`	integer	No	-
`processing`	integer	No	-

Generated example (synthetic):

{
  "data": {
    "jobs_cancelled": 0,
    "remaining_jobs": {
      "completed": 0,
      "failed": 0,
      "processing": 0
    },
    "sync_id": "string"
  },
  "success": false
}

400 - object

Error

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

500 - object

Error

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Integrations API
Method: DELETE
Path: /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync/\{sync_id\}
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Sync
OpenAPI summary: Stop sync job