v5

latestOpenAPI 3.0.02026-08-04258282491.7 KB

Custom components

Update a custom component.

Update a custom component. The template is sanitized server-side; unsafe markup is rejected with 400.

put/custom-components/{customComponentId}

Path parameters

customComponentIdstring required

Headers

projectstring required

Request body

namestring required

Unique kebab-case identifier within the project (^[a-z][a-z0-9-]{1,49}$, 2-50 chars).

descriptionstring

Short description shown to the AI, max 120 characters.

whenToUsestring

Guidance for the AI on when to render this component, max 500 characters.

{"stackTrail":"components:schemas:CustomComponentDTO:properties:schema","oasType":"schema","type":"unknown"}

templatestring required

HTML template, max 20000 characters. Sanitized server-side; unsafe markup is rejected with 400. The sanitized result is returned as the read-only sanitizedTemplate field.

{"stackTrail":"components:schemas:CustomComponentDTO:properties:exampleData","oasType":"schema","type":"unknown"}

isPublishedboolean

Response

updatedAtstring required

createdAtstring required

createdBystring

isPublishedboolean required

{"stackTrail":"components:schemas:CustomComponentDocument:allOf:properties:exampleData","oasType":"schema","type":"unknown"}

sanitizedTemplatestring required

templatestring required

whenToUsestring required

descriptionstring required

namestring required

{"stackTrail":"components:schemas:CustomComponentDocument:allOf:properties:schema","oasType":"schema","type":"unknown"}