Plane

Interact with Plane API — issues, cycles, modules, pages, and more

Actions32

Module → Update

AI-generated

Summary

Update an existing Module in Plane by specifying its Module ID and optionally changing its Name and/or Description.

Inputs

  • Module ID (required) — The unique identifier of the Module to update.
  • Name — The new name to assign to the Module.
  • Description — The new description to assign to the Module.

Output shape

a single updated Module record as a JSON object

Returns the updated Module object as received from the Plane API after applying changes. Errors are returned as JSON objects in case of failure.

Examples

Example 1: Update the name and description of a Module by its Module ID.

Set the Resource to 'Module', Operation to 'Update', provide the Module ID, and specify new values for Name and/or Description.

Links

Discussion