Sign in
Practice Review Sweep

Replace a sweep schedule's terms

Changes the cadence, the window, or whether the sweep runs at all.

put/workspaces/{workspaceSlug}/practices/sweep-schedules/{scheduleId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/sweep-schedules/{scheduleId}
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

scheduleIdstring uuid required

Request body

cadence'DAILY' | 'WEEKLY' required

How often the sweep runs

enabledboolean required

Whether the scheduler acts on this row; a disabled schedule keeps its terms

lookbackDaysinteger required

How far back each sweep looks, in days

Example request

{
  "lookbackDays": 2
}

Response

Schedule updated

artifactKindstring required
cadence'DAILY' | 'WEEKLY' required
createdAtstring date-time required
createdByAccountIdinteger required
enabledboolean required
idstring uuid required
lastRunAtstring date-time

When a campaign was last opened from this schedule; absent until the first one

lookbackDaysinteger required

how far back each sweep looks. Bounded at write time to twice the cadence and never more than a week, which is what keeps a sweep's observations admissible in the same trend line as reviews that events triggered.

nextRunAtstring date-time required

when the next sweep is due. Shown because it is the only way to tell a schedule that is working from one whose workspace has been skipping it.

Changes

No recorded changes to this operation across all 1 revision of this API.