For Developers
Cancel Sync
POST https://ed.link/api/v2/teams/:team_id/sources/:source_id/syncs/:sync_id/cancel
Cancels a queued, working, or pending sync and discards its staged data.
Permissions
Requires the syncs.update system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:source_id | UUID | Yes | The ID of the source. |
:sync_id | UUID | Yes | The ID of the sync to cancel. |
Sample Request
const response = await axios.post(
`https://ed.link/api/v2/teams/${team_id}/sources/${source_id}/syncs/${sync_id}/cancel`,
{},
{
headers: {
authorization: `Bearer ${user_session_token}`
}
}
);
Response
Returns HTTP 204 No Content with no response body. Queued and working syncs become canceled; a pending sync becomes killed. Staged data for the sync is discarded.
