Sign in
Modules

Rename, edit, or move a module

Changed on

Member-only (role >= member). Renaming rebuilds the module path and every descendant path; parent_module_id moves the module (and its subtree) to a new parent or the project root. parent_module_id is mutually exclusive with name/description — a combined update+move request returns 422 (combined_update_and_move); send them as separate PATCH calls. A sibling/destination slug collision returns 409; a cycle, depth-overflow, or invalid target returns 422. An archived module reads as 404. Viewers/non-members return 403.

patch/api/v1/modules/{id}

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/modules/{id}
  • Auth: one of:
    • API key in cookie sb-fmbpikzpkafptqximhxn-auth-token
    • HTTP bearer

Path parameters

idstring uuid required

Request body

namestring

New name, 2–80 chars, at least one alphanumeric. Renaming rebuilds the module path and every descendant path. Mutually exclusive with parent_module_id — a rename cannot be combined with a move.

descriptionstring nullable

New description (max 500 chars). Pass null to clear it; omit to leave it unchanged. Mutually exclusive with parent_module_id — a description edit cannot be combined with a move.

parent_module_idstring uuid nullable

Move the module: a UUID re-parents it under that module (carrying its subtree); null moves it to the project root; omit to leave the parent unchanged. Rejects cycles, depth > 6, and cross-project targets. Mutually exclusive with name/description — combining a move with a rename/description edit returns 422 (combined_update_and_move).

Response

Module updated.

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status