Create a new component library component
Creates a new library component (reusable workspace template) with name, description, icon, tags, and internal notes.
What are Library Components? Library components are workspace-wide reusable templates (projectId is null). They serve as blueprints that can be imported into projects to standardize recurring project types. 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 component 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 library 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.
/administration/project-components/componentsAuthorizationOAuth2 access token · headerrequiredapi:writeAuthorizationBearer token (JWT) · headerrequiredfieldsToReturnstringComma-separated list of top-level response fields to return. Overrides the endpoint compact default unless responseShape=full is used.
responseShapestringAdvanced 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.
compactfullLT-Response-ShapestringAdvanced override. Set to full only when you need the complete endpoint response, including nested fields that are not selectable with fieldsToReturn.
fullapplication/jsondescriptionstringrequiredDescription (HTML or Markdown)
iconobject | nullIcon identifier. Format: :icon_name: (e.g., :rocket:, :box:, :star:)
internalNotestringInternal note (HTML or Markdown, optional)
namestringrequiredComponent name
tagsstring[]Tag UUIDs
Component created successfully
idstring<uuid>Invalid request: missing required fields or invalid UUID format for tags
Unauthorized - Invalid or missing authentication token
Insufficient permissions to edit component library
Editor content conversion errors