Sign in
Sync

Update a running sync job

Changed on
patch/workspaces/{workspaceSlug}/connections/{connectionId}/sync/jobs/{jobId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/connections/{connectionId}/sync/jobs/{jobId}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

connectionIdinteger required
jobIdinteger required

Request body

cancelRequestedboolean required

Response

Cancellation requested; the running job stops cooperatively

cancelRequestedboolean required

Whether a cooperative cancel was requested

createdAtstring date-time required

When the job row was created

errorSummarystring

Truncated error summary, set on FAILED

finishedAtstring date-time

When the job finished (any terminal status)

idinteger required

Job id

itemsProcessedinteger

Coarse progress: items processed so far

itemsTotalinteger

Coarse progress: total items, if known

progressobject

Per-phase progress detail, integration-specific shape

startedAtstring date-time

When the job started running

status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'SUCCEEDED_WITH_WARNINGS' | 'FAILED' | 'CANCELLED' required

Job status

trigger'SCHEDULED' | 'MANUAL' | 'LIFECYCLE' | 'SYSTEM' required

What initiated this job

triggeredByUserIdinteger

Account id of the admin who triggered this job, if MANUAL

type'INITIAL' | 'RECONCILIATION' | 'BACKFILL' required

What kind of pass this is

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$