Skip to main content
DELETE
Delete Component

Path Parameters

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

Query Parameters

string
true deletes a component that only draft content types (never published) still use. It never overrides a published, modified or unpublished content type.
Deleting a component sets its status to deleted; it can be brought back with Restore Component. The request fails with 409:
  • COMPONENT_IN_USE_BY_PUBLISHED when a published, modified or unpublished content type uses the component as its root or in its allowed components. force=true does not override this: delete or change those content types first.
  • COMPONENT_IN_USE_BY_DRAFT when only draft content types use it, unless you add force=true.
Deleted content types do not count, so deleting a content type and then its root component works. Requires the components.delete permission.

Response

Error Responses

Component In Use by a Published Content Type (409)

Component In Use by Draft Content Types (409)

Not Found

Code Examples