Skip to main content
PATCH
Update a schedule

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

scheduleId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"sched_123"

Body

application/json
name
string

Display name shown in the dashboard.

Required string length: 1 - 120
Example:

"Weekly changelog"

sourceType
enum<string>

Always cron for schedules.

Available options:
cron
sourceConfig
object

Replaces the cron settings as a whole. Send every cron field the frequency needs.

targets
object

Data source changes. The schedule must keep at least one GitHub or Linear integration.

outputType
enum<string>

Type of content each run generates.

Available options:
changelog,
blog_post,
linkedin_post,
twitter_post,
image
Example:

"changelog"

outputConfig
object | null

Output setting changes, merged field by field into the current settings. Set a field to null to clear it, or send null to clear all of them.

enabled
boolean

Whether the schedule runs. Disabled schedules are stored but never fire.

Example:

true

autoPublish
boolean

Save generated changelogs and blog posts with status published instead of draft. This only marks them published in Notra; nothing is pushed to GitHub or a Notra site. Other output types always stay drafts.

lookbackWindow
enum<string>

How far back each run collects source activity.

Available options:
current_day,
yesterday,
last_7_days,
last_14_days,
last_30_days

Response

Schedule updated successfully

schedule
object
required
organization
object
required