Skip to main content
POST
Update Component Status

Path Parameters

organizationId
string
required
Organization ID
projectId
string
required
Project ID
id
string
required
Component ID

Request Body

status
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

FromToAllowed
draftdeletedYes
modifieddeletedYes
publisheddeletedYes
deleteddraftYes (restore)
deletedmodifiedYes (restore, if previously published)
AnypublishedNo (use package creation)

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 or modified to restore a deleted component:

Error Responses

Invalid Status Transition

Cannot Restore Deleted Component

Code Examples