Create a new component in a project

Creates a new project component (reusable project template) with name, description, icon, tags, and internal notes.

What are Project Components? Project components are reusable project templates that standardize recurring project types. They serve as blueprints for planning, pricing, and executing similar projects consistently. Components connect requirements management, cost calculation, and execution in one unified workflow.

After Creating a Component: Once created, you can add items (Epics, Work Packages, Todo Lists, Test Suites) to define the project structure. You can also add questions to capture customer requirements, todos for checklists, and test cases for acceptance testing.

Component Placement: The component is automatically appended to the end of the project component list. You can reorder components later using the sort endpoint.

Content Format: Description and internal note fields accept HTML or Markdown input and are automatically converted to the internal IDoc format for storage. When retrieved, this content is converted back to HTML for easy consumption.

Side Effects: Creating a component automatically triggers project configuration change tracking, marking the project as having been modified.

POST/projects/{projectId}/components

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstringrequired

Query parameters

fieldsToReturnstring

Comma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.

responseShapestring

Advanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:compactfull

Header parameters

LT-Response-Shapestring

Advanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Allowed:full

Request body

requiredapplication/json

descriptionstringrequired

Component description in HTML or Markdown format

iconobject

Icon identifier for the component

internalNotestring

Internal note in HTML or Markdown format

namestringrequired

Component name

tagsstring[]

Array of tag IDs to associate with the component

Responses

201

Component created successfully

idstringrequired

UUID of the created component

400

Invalid request: missing required fields or invalid UUID format for tags

401

Unauthorized - Invalid or missing authentication token

403

Insufficient permissions to create components or access to project denied

404

Project not found or not accessible

422

Editor content conversion errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

projectIdpath*fieldsToReturnqueryComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.responseShapequeryAdvanced override. Omit for the endpoint compact default. Use full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.LT-Response-ShapeheaderAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.

Bodyapplication/json

Request body

Request

curl -X POST "https://leadtime.app/api/public/projects/string/components" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "<p>User authentication and authorization module</p>",
  "icon": "icon-lock",
  "internalNote": "<p>This is an internal development note</p>",
  "name": "Authentication Module",
  "tags": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}'

const response = await fetch("https://leadtime.app/api/public/projects/string/components", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"<p>User authentication and authorization module</p>\",\n  \"icon\": \"icon-lock\",\n  \"internalNote\": \"<p>This is an internal development note</p>\",\n  \"name\": \"Authentication Module\",\n  \"tags\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://leadtime.app/api/public/projects/string/components",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"<p>User authentication and authorization module</p>\",\n  \"icon\": \"icon-lock\",\n  \"internalNote\": \"<p>This is an internal development note</p>\",\n  \"name\": \"Authentication Module\",\n  \"tags\": [\n    \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n  ]\n}",
)

Response

{
  "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890"
}