Skip to content
GitmoapAPIBeta
Identity & platformonboarding
PATCH/user/onboarding

Set the caller's onboarding intent or dismiss the checklist

patch_user_onboarding
  • onboarding:manage
    A token needs the onboarding:manage scope: Update onboarding intent and dismissalGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

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

Records what you came to Gitmoap to do, or dismisses your getting-started checklist. The checklist's steps tick themselves off from what you have actually done; this changes only your answer, and whether you see the checklist.

Request body

application/json
  • dismissedboolean or nulloptional
  • intentOnboardingIntentsoloteamunknownor nulloptionalThe person's stated goal, captured by the first-run Welcome. Unknown is the canonical "the Welcome has not been completed" signal — a fresh record starts here, and the first PATCH to Solo/Team retires the Welcome. There is deliberately no separate "onboarded" flag.
Request body exampleSynthesized example
{}

Responses

200Updated onboarding stateapplication/json
  • activationOnboardingActivation
    • The OnboardingActivation schema
    • has_access_tokenbooleanWhether the caller holds any personal access token (a connected git client).
    • clone_hintstring or nulloptionalA suggested git clone command for a new repo in the namespace.
    • personal_group_idGroupId (string · uuid) or nulloptionalThe personal namespace group id — lets the frontend PUT /groups/{id} and target repo creation without a path→id lookup that a mid-Welcome namespace rename would desync.
    • personal_namespace_pathstring or nulloptionalThe personal namespace's current path to clone into.
  • dismissedboolean
  • intentOnboardingIntentsoloteamunknownThe person's stated goal, captured by the first-run Welcome. Unknown is the canonical "the Welcome has not been completed" signal — a fresh record starts here, and the first PATCH to Solo/Team retires the Welcome. There is deliberately no separate "onboarded" flag.
  • required_stepsarray of string
  • stepsOnboardingSteps
    • The OnboardingSteps schema
    • connected_git_clientstring or nulloptional
    • created_first_repostring or nulloptional
    • created_namespacestring or nulloptional
    • email_verifiedstring or nulloptional
    • pushed_first_commitstring or nulloptional
  • completed_atstring or nulloptional
  • next_stepstring or nulloptional
200 exampleSynthesized example
{
"activation": {
"has_access_token": false,
"clone_hint": "clone-hint-abbc",
"personal_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"personal_namespace_path": "personal-namespace-path-7865"
},
"dismissed": false,
"intent": "solo",
"required_steps": [
"required-steps-f554",
"required-steps-ae4f"
],
"steps": {
"connected_git_client": "connected-git-client-57b1",
"created_first_repo": "created-first-repo-ceb6",
"created_namespace": "created-namespace-9ca0",
"email_verified": "mara@acme.example",
"pushed_first_commit": "pushed-first-commit-d217"
},
"completed_at": "2026-10-15T03:51:44Z",
"next_step": "next-step-c12b"
}
400Invalid requestapplication/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-dd38",
"message": "Pin a page's payload to the build that rendered it"
}
}
401Unauthorizedapplication/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-6bff",
"message": "Draw the region map from operation density"
}
}
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-cdf7",
"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-2b5e",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap onboarding patch-user-onboarding

  • --dismissedflagoptional
  • --intentsolo | team | unknownoptional

Used in these guides