Archive a module

POST/api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/archive/

Archives a module, while preserving its data.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

project_id:requiredstring

The unique identifier of the project.

module_id:requiredstring

The unique identifier for the module.

Archive a module

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/archive/" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/archive/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch(
  'https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/module-uuid/archive/',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'your-api-key',
    },
  },
);
const data = await response.json();

Response201

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}