Schedules
Update a schedule
Changed onReplaces the schedule. Send the full schedule body; fields that are omitted are not preserved from the existing schedule.
patch/v1/schedules/{scheduleId}
Request
- Base URL: https://api.usenotra.com
- URL: https://api.usenotra.com/v1/schedules/{scheduleId}
- Auth: HTTP bearer
Path parameters
scheduleIdstring required
Example:sched_123
Request body
Example request
{
"name": "Weekly changelog",
"sourceConfig": {
"cron": {
"frequency": "weekly",
"hour": 9,
"dayOfWeek": 1,
"dayOfMonth": 1,
"intervalDays": 3,
"anchorDate": "2026-09-03"
}
},
"targets": {
"repositoryIds": [
"51c2f3aa-efdd-4e28-8e69-23fa2dfd3561"
]
},
"outputType": "changelog",
"outputConfig": {
"brandVoiceId": "51c2f3aa-efdd-4e28-8e69-23fa2dfd3561",
"instructions": "Write a tutorial-style post that walks through one feature shipped in this window, with code samples."
},
"enabled": true,
"lookbackWindow": "last_7_days"
}Response
Schedule updated successfully
Example response
{
"schedule": {
"sourceConfig": {
"cron": {
"frequency": "weekly",
"hour": 9,
"dayOfWeek": 1,
"dayOfMonth": 1,
"intervalDays": 3,
"anchorDate": "2026-09-03"
}
},
"targets": {
"repositoryIds": [
"51c2f3aa-efdd-4e28-8e69-23fa2dfd3561"
]
},
"outputConfig": {
"brandVoiceId": "51c2f3aa-efdd-4e28-8e69-23fa2dfd3561",
"instructions": "Write a tutorial-style post that walks through one feature shipped in this window, with code samples."
}
}
}Changes
- warning
added the new
customenum value to the///response property for the response status - info
added the new optional request property
/ - info
added the new optional request property
// - info
added the new optional request property
// - info
added the new
customenum value to the request property// - info
added the optional property
//to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status
- warning