Skip to content
GitmoapAPIBeta
Planissues
PATCH/groups/{group_id}/iteration-cadences/{cadence_id}

Update an iteration cadence

update_iteration_cadence
  • iteration:manage
    A token needs the iteration:manage scope: Define and remove iterations and their cadences, and roll an iteration's unfinished work overGranted by write_api, write_repository.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Changes a cadence's title or how many upcoming iterations it keeps created, or pauses it with active: false and resumes it with true; only the fields you send change, and at least one is required. A paused cadence creates nothing and keeps what it made; resuming one creates what it now owes, but never an iteration that has already ended. The schedule cannot be changed — pause the cadence and create another. Maintainers and above may update cadences.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID
  • cadence_idCadenceId (string · uuid)Cadence ID

Request body

application/json
  • activeboolean or nulloptionalPause it with false, or resume it with true.
  • iterations_in_advanceinteger · int32 or nulloptional0–∞How many upcoming iterations to keep created: 1 to 12.
  • titleCadenceTitle (string) or nulloptionalA new title, used for iterations it generates from now on.
Request body exampleSynthesized example
{}

Responses

200The cadenceapplication/json
  • activebooleanWhether it generates iterations. A paused cadence generates nothing and keeps what it made.
  • cadence_idCadenceId (string · uuid)The cadence's identifier.
  • cool_down_weeksinteger · int320–∞Weeks left between one iteration's end and the next one's start, which belong to no iteration: 0 to 4. Shape Up's cool-down between cycles.
  • created_atstringWhen it was created, ISO 8601.
  • duration_weeksinteger · int320–∞How long each iteration runs, in weeks: 1 to 12.
  • first_start_dateCalendarDate (string)The date the schedule starts from. The first iteration begins on the first start_day on or after it.
  • generated_throughinteger · int320–∞The number of the last iteration it has generated, or 0 before the first.
  • group_idGroupId (string · uuid)The group whose iterations it generates.
  • iterations_in_advanceinteger · int320–∞How many upcoming iterations are kept created ahead of today: 1 to 12.
  • start_dayWeekdaymondaytuesdaywednesdaythursdayfridaysaturdaysundayThe weekday every iteration begins on.
  • titleCadenceTitle (string)Its title. Each iteration it generates is titled with it and the iteration's number.
  • updated_atstringWhen it last changed, ISO 8601.
200 exampleSynthesized example
{
"active": true,
"cadence_id": "5b5e2473-02c6-4886-a11e-a1c9c20e6519",
"cool_down_weeks": 24,
"created_at": "2026-10-14T17:38:02Z",
"duration_weeks": 37,
"first_start_date": "first-start-date-94e3",
"generated_through": 52,
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iterations_in_advance": 21,
"start_day": "monday",
"title": "Inline scalar newtypes but keep their brand",
"updated_at": "2026-10-12T16:33:52Z"
}
400Nothing to change, or a look-ahead out of rangeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-660e",
"message": "Stream pipeline status into the run header"
}
}
401Unauthenticated — no credential, or an invalid oneapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-b0a5",
"message": "Label every synthesized example"
}
}
403Forbidden — the caller's access level or token scope is insufficientapplication/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-3aa4",
"message": "Pin a page's payload to the build that rendered it"
}
}
404Cadence not found in this groupapplication/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-1749",
"message": "Inline scalar newtypes but keep their brand"
}
}
409The request conflicts with the resource's current state; `reason` says howapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
409 exampleSynthesized example
{
"error": {
"code": "code-832f",
"message": "Label every synthesized example"
}
}

CLI

gitmoap issues update-iteration-cadence

  • --group-ididGroup ID (id or group path)
  • --cadence-ididCadence ID
  • --activeflagoptionalPause it with `false`, or resume it with `true`.
  • --iterations-in-advancenumberoptionalHow many upcoming iterations to keep created: 1 to 12.
  • --titlestringoptional

Used in these guides