CLclickup
Folders

Create Folder from template

Changed on

Create a new Folder using a Folder template within a Space. This endpoint allows you to create a folder with all its nested assets (lists, tasks, etc.) from a predefined template available in your Workspace. Publicly shared templates must be added to your Workspace before you can use them with the public API. You can optionally create the Folder as a subfolder within an existing Folder by providing parent_folder_id in the request body. Subfolder support must be enabled for the Workspace. This request can be run asynchronously or synchronously via the return_immediately parameter.

post/v2/space/{space_id}/folder_template/{template_id}

Request

  • Base URL
    https://api.clickup.com/api
  • URL
    https://api.clickup.com/api/v2/space/{space_id}/folder_template/{template_id}
  • Auth
    API key in header Authorization

Path parameters

space_idstring required

ID of the Space where the Folder will be created

template_idstring required
Example:t-7162342

ID of the Folder template to use. Template IDs include a t- prefix (e.g., t-7162342). Retrieve available template IDs using the Get Folder Templates endpoint.

Request body

namestring required

Name of the new Folder

parent_folder_idstring

ID of an existing Folder to create this Folder inside of as a subfolder. The parent Folder must belong to the same Space specified in the path. Subfolder support must be enabled for the Workspace.

Response

Folder created successfully

idinteger

ID of the created Folder

Example response

{
  "id": 90114316773,
  "folder": {
    "id": "90114316773",
    "name": "Projects",
    "orderindex": 0,
    "override_statuses": true,
    "hidden": false,
    "space": {
      "id": "90112667046",
      "name": "Client Facing",
      "access": true
    },
    "task_count": "0",
    "archived": false,
    "statuses": [
      {
        "id": "c90114316773_syqLtYOY",
        "status": "complete",
        "orderindex": 2,
        "color": "#008844",
        "type": "closed"
      },
      {
        "id": "c90114316773_g9uxhsQM",
        "status": "in progress",
        "orderindex": 1,
        "color": "#1090e0",
        "type": "custom"
      },
      {
        "id": "c90114316773_DCnaeiSB",
        "status": "to do",
        "orderindex": 0,
        "color": "#87909e",
        "type": "open"
      }
    ],
    "lists": [],
    "parent_folder": "90114316772",
    "permission_level": "create"
  }
}

Changes

  • a0a72ec97ddbRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status