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

Create an iteration cadence

create_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"}

  • Quota · iteration cadences per group

    x-gitmoap-quota: {"kind":"enforced","arg":"iteration_cadences_per_group"}

Creates a schedule that generates the group's iterations: each runs duration_weeks weeks, starting on start_day, from the first such day on or after first_start_date, with cool_down_weeks weeks between one iteration and the next — set it for Shape Up's cool-down. The current iteration and the next iterations_in_advance are created straight away and kept topped up every day, each counting toward the group's iteration limit; a cadence at that limit stops generating until one is deleted. The schedule cannot be changed afterwards. Maintainers and above may create cadences, up to the group's cadence limit.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID

Request body

application/json
  • first_start_dateCalendarDate (string)The date the schedule starts from. The first iteration begins on the first start day on or after it.
  • titleCadenceTitle (string)Its title. Each iteration it generates is titled with it and the iteration's number.
  • activeboolean or nulloptionalWhether it starts generating straight away. Defaults to true.
  • cool_down_weeksinteger · int32 or nulloptional0–∞Weeks left between iterations that belong to none: 0 to 4. Defaults to 0.
  • duration_weeksinteger · int32 or nulloptional0–∞How long each iteration runs, in weeks: 1 to 12. Defaults to 2.
  • iterations_in_advanceinteger · int32 or nulloptional0–∞How many upcoming iterations to keep created ahead of today: 1 to 12. Defaults to 4.
  • start_dayWeekdaymondaytuesdaywednesdaythursdayfridaysaturdaysundayor nulloptionalThe weekday iterations begin on. Defaults to Monday.
Request body exampleSynthesized example
{
"first_start_date": "first-start-date-f3d7",
"title": "Stream pipeline status into the run header"
}

Responses

201The 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.
201 exampleSynthesized example
{
"active": true,
"cadence_id": "df4b397f-5189-4577-830e-97ed2d588146",
"cool_down_weeks": 60,
"created_at": "2026-10-14T23:23:57Z",
"duration_weeks": 55,
"first_start_date": "first-start-date-c617",
"generated_through": 50,
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iterations_in_advance": 35,
"start_day": "monday",
"title": "Stream pipeline status into the run header",
"updated_at": "2026-10-11T07:05:32Z"
}
400A duration, cool-down or 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-46dd",
"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-32fe",
"message": "Stream pipeline status into the run header"
}
}
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-c3a8",
"message": "Inline scalar newtypes but keep their brand"
}
}
404Not found — or found and private, which is masked as absentapplication/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-5dcd",
"message": "Label every synthesized example"
}
}
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-2bb8",
"message": "Stream pipeline status into the run header"
}
}
429The group is at its cadence limitapplication/json
Error codes
  • TOO_MANY_REQUESTSRetryableA quota, a rate limit or a transfer budget is spent. When the response carries Retry-After, retry after that many seconds
  • 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.
429 exampleSynthesized example
{
"error": {
"code": "code-6ac5",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap issues create-iteration-cadence

  • --group-ididGroup ID (id or group path)
  • --activeflagoptionalWhether it starts generating straight away. Defaults to true.
  • --cool-down-weeksnumberoptionalWeeks left between iterations that belong to none: 0 to 4. Defaults to 0.
  • --duration-weeksnumberoptionalHow long each iteration runs, in weeks: 1 to 12. Defaults to 2.
  • --first-start-datestringThe date the schedule starts from. The first iteration begins on the first start day on or after it.
  • --iterations-in-advancenumberoptionalHow many upcoming iterations to keep created ahead of today: 1 to 12. Defaults to 4.
  • --start-daymonday | tuesday | wednesday | thursday | friday | saturday | sundayoptional
  • --titlestringIts title. Each iteration it generates is titled with it and the iteration's number.

Used in these guides