Partially update a project component

Updates only the provided fields of an existing component in a project. The description and internalNote fields accept HTML or Markdown and will be converted to the internal format. Updating a component triggers project configuration change tracking.

PATCH/projects/{projectId}/components/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstringrequired

idstringrequired

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

descriptionstring

Component description (HTML or Markdown)

discountAmountnumber

Discount amount to apply to this component. For percentage discounts, this is the percentage (0-100). For fixed discounts, this is the amount in workspace currency. Set to 0 to remove the discount.

min 0

discountTypestring

Type of discount. "Percentage" applies a percentage reduction, "Fixed" applies a fixed amount reduction. Required when discountAmount is provided.

Allowed:FixedPercentage

iconobject | null

Icon identifier (can be set to null)

internalNotestring

Internal note (HTML or Markdown)

namestring

Component name

tagsstring[]

Array of tag IDs

Responses

200

Component updated successfully

idstringrequired

UUID of the updated component

400

Invalid request: invalid UUID format for component ID, project ID, or tag IDs

401

Unauthorized - Invalid or missing authentication token

403

Insufficient permissions to manage components or access to project denied

404

Component not found, component does not belong to project, or project 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*idpath*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 PATCH "https://leadtime.app/api/public/projects/string/components/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "<p>This component handles user authentication and authorization.</p>",
  "discountAmount": 10,
  "discountType": "Percentage",
  "icon": "🔐",
  "internalNote": "<p>Implementation notes for the development team.</p>",
  "name": "User Authentication Module",
  "tags": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}'

const response = await fetch("https://leadtime.app/api/public/projects/string/components/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"description\": \"<p>This component handles user authentication and authorization.</p>\",\n  \"discountAmount\": 10,\n  \"discountType\": \"Percentage\",\n  \"icon\": \"🔐\",\n  \"internalNote\": \"<p>Implementation notes for the development team.</p>\",\n  \"name\": \"User Authentication Module\",\n  \"tags\": [\n    \"550e8400-e29b-41d4-a716-446655440000\"\n  ]\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/projects/string/components/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"description\": \"<p>This component handles user authentication and authorization.</p>\",\n  \"discountAmount\": 10,\n  \"discountType\": \"Percentage\",\n  \"icon\": \"🔐\",\n  \"internalNote\": \"<p>Implementation notes for the development team.</p>\",\n  \"name\": \"User Authentication Module\",\n  \"tags\": [\n    \"550e8400-e29b-41d4-a716-446655440000\"\n  ]\n}",
)

Response

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