diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 7e9d7756..e678d1c6 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -501,6 +501,10 @@ export default extendConfig( items: [ { text: "Overview", link: "/api-reference/project/overview" }, { text: "Create Project", link: "/api-reference/project/add-project" }, + { + text: "Create Project with Template", + link: "/api-reference/project/create-project-with-template", + }, { text: "List Projects", link: "/api-reference/project/list-projects" }, { text: "Get Project", link: "/api-reference/project/get-project-detail" }, { text: "Update Project", link: "/api-reference/project/update-project-detail" }, diff --git a/docs/api-reference/project/create-project-with-template.md b/docs/api-reference/project/create-project-with-template.md new file mode 100644 index 00000000..c9a86730 --- /dev/null +++ b/docs/api-reference/project/create-project-with-template.md @@ -0,0 +1,175 @@ +--- +title: Create project with template +description: Create a project from an existing project template via Plane API. HTTP request format, parameters, scopes, and example responses for create project with template. +keywords: plane, plane api, rest api, api integration, project, create project with template, project template +--- + +# Create project with template + +
+ POST + /api/v1/workspaces/{workspace_slug}/projects/templates/use/ +
+ +
+
+ +Create a new project from an existing project template. The template's states, labels, estimates, modules, and work items are copied into the new project. Fields provided in the request body override the template defaults. + +
+ +### Path Parameters + +
+ + + +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`. + + + +
+
+ +
+ +### Body Parameters + +
+ + + +The ID of the project template to instantiate. Must belong to the same workspace. + + + + + +Name of the new project. Overrides the template default. + + + + + +Short identifier for the project (e.g. `MAR`). Overrides the template default. + + + + + +Description of the new project. Overrides the template default. + + + + + +Network visibility of the project. `0` for secret, `2` for public. Overrides the template default. + + + + + +User ID of the project lead. The lead is added as a project admin. Overrides the template default. + + + +
+
+ +
+ +### Scopes + +`write` or `projects:write` + +
+ +
+ +
+ + + + + + + + + +```json +{ + "id": "550e8400-e29b-41d4-a716-446655440000", + "name": "Mobile App Revamp", + "description": "Project created from the Agile Project Setup template", + "identifier": "MAR", + "network": 2, + "project_lead": "0d8d8869-3ed1-4fb4-b5c4-ff672888f5e2", + "created_at": "2024-01-01T00:00:00Z", + "updated_at": "2024-01-01T00:00:00Z" +} +``` + + + +
+ +
diff --git a/docs/api-reference/project/overview.md b/docs/api-reference/project/overview.md index 22a8b6d3..321de20e 100644 --- a/docs/api-reference/project/overview.md +++ b/docs/api-reference/project/overview.md @@ -131,6 +131,10 @@ Projects organize your team's work within a workspace. Each project contains wor Default state which will be used when the issues will be auto closed +- `template_id` _uuid_ + + UUID of the project template used to create this project. +