Skip to content
GitmoapAPIBeta
Planissue-blueprints
POST/groups/{group_id}/issue-blueprints

Define a custom work-item type on a group

create_group_blueprint
  • issue_blueprint:manage
    A token needs the issue_blueprint:manage scope: Define and remove custom work-item types (blueprints)Granted by write_api, write_repository.Every operation this scope unlocks
  • Audited · mutation

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

  • Quota · blueprints per scope

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

Creates a blueprint: a named custom type built on one of the base work-item types, whose facets become acceptance criteria on every work item filed as that type. The repositories and groups beneath the group are offered it too. Its id is a slug, unique in the group. Maintainers and above may define types, up to the group's limit.

Parameters

Path
  • group_idGroupId (string · uuid)Group ID

Request body

application/json
  • base_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe kind of work item. The type decides where an item may live (a group or a repository), which types it may have as children, and which fields it accepts.
  • blueprint_idBlueprintId (string)The custom-type slug, unique within the scope.
  • namestring
  • descriptionstring or nulloptional
  • facetsarray of FacetTemplateoptional
    • The FacetTemplate schema
    • categoryFacetCategory (string)The facet's category — any value you choose. Facets with the same category are grouped together.
    • keyFacetKey (string)The facet's identifier within the blueprint. It stays the same when the label changes, so a work item re-applying the blueprint updates the facet in place.
    • labelstringThe facet's display name, such as "Observability".
    • bindingFacetBindingTemplateoptionalHow the seeded criterion is bound. Defaults to a manual checkbox.
    • hintstring or nulloptionalThe starter criterion's text. When absent the criterion is titled by the facet label.
    • requiredbooleanoptionalWhether the facet's criterion must be satisfied before the work item can be closed or verified. Defaults to true.
Request body exampleSynthesized example
{
"base_type": "epic",
"blueprint_id": "2ee73f14-2294-45a4-bd9a-963f8b1dc1d2",
"name": "payments-api"
}

Responses

200The created blueprintapplication/json
  • base_typeWorkItemTypeepicstorybugtaskspikechoreincidentsub_taskThe built-in type the custom type is based on, which decides where its items may live, their children and their fields. "API Feature" might be a story with a blueprint on top.
  • blueprint_idBlueprintId (string)The blueprint's slug, unique within its group or repository. It never changes.
  • created_atstring
  • created_byActorSummaryWho created the blueprint, as they were when they created it.
  • namestringThe custom type's display name, such as "API Feature".
  • scope_idstring
  • scope_typeScopeTypegrouprepository
  • updated_atstring
  • archivedbooleanoptionalHidden from the type picker; items already filed keep their type_profile.
  • descriptionstring or nulloptional
  • facetsarray of FacetTemplateoptionalThe blueprint's facets, in order.
    • The FacetTemplate schema
    • categoryFacetCategory (string)The facet's category — any value you choose. Facets with the same category are grouped together.
    • keyFacetKey (string)The facet's identifier within the blueprint. It stays the same when the label changes, so a work item re-applying the blueprint updates the facet in place.
    • labelstringThe facet's display name, such as "Observability".
    • bindingFacetBindingTemplateoptionalHow the seeded criterion is bound. Defaults to a manual checkbox.
    • hintstring or nulloptionalThe starter criterion's text. When absent the criterion is titled by the facet label.
    • requiredbooleanoptionalWhether the facet's criterion must be satisfied before the work item can be closed or verified. Defaults to true.
  • versioninteger · int64optional0–∞The blueprint's revision, incremented on every change. An update must send the version it read, and is refused with a 409 if the blueprint changed since.
200 exampleSynthesized example
{
"base_type": "epic",
"blueprint_id": "6d63ba32-895f-428f-8fc4-e2162546885c",
"created_at": "2026-10-10T00:19:51Z",
"created_by": {
"email": "tomas@acme.example",
"id": "id-be2b",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/9f45476d"
},
"name": "payments-api",
"scope_id": "1339b37c-eeb1-4b6e-b02a-a8cbdc67f495",
"scope_type": "group",
"updated_at": "2026-10-10T02:32:33Z",
"archived": false,
"description": "Renders each region as density contours of its operations.",
"facets": [
{
"category": "category-22a2",
"key": "key-3353",
"label": "label-5822"
},
{
"category": "category-df06",
"key": "key-23b8",
"label": "label-d370"
}
],
"version": 48
}
400Invalid facets, or a bound facet on a group-only base typeapplication/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-398a",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-8d29",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-00b5",
"message": "Draw the region map from operation density"
}
}
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-2766",
"message": "Draw the region map from operation density"
}
}
409A blueprint with this id already exists in the scopeapplication/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-2a13",
"message": "Draw the region map from operation density"
}
}
429Per-scope blueprint limit reachedapplication/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-9640",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap issue-blueprints create-group-blueprint

  • --group-ididGroup ID (id or group path)
  • --base-typeepic | story | bug | task | spike | chore | incident | sub_task
  • --blueprint-idstringThe custom-type slug, unique within the scope.
  • --descriptionstringoptional
  • --facetsjsonoptional
  • --namestring

Used in these guides