Skip to main content
POST
Update Component Status

Path Parameters

string
required
Organization ID
string
required
Project ID
string
required
Component ID

Request Body

string
required
New status: draft, modified, published, or deleted
Components cannot be manually set to published status. Components are published automatically when included in a package. To publish a component, create a new package.

Status Transitions

Setting deleted is a delete: it applies the same checks as Delete Component without force (409 COMPONENT_IN_USE_BY_PUBLISHED or COMPONENT_IN_USE_BY_DRAFT). Setting draft on a deleted component is a restore (409 COMPONENT_NAME_EXISTS when another component has taken its name). Both need the components.delete permission; other changes need components.update.

Response

Returns the updated Component object.

Use Cases

Soft Delete a Component

Set status to deleted to prevent future use while maintaining existing package references:

Restore a Deleted Component

Set status back to draft to restore a deleted component (the same as Restore Component without a new name):

Error Responses

Invalid Status Transition

Cannot Restore Deleted Component

Code Examples