Download API definition:

PUT https://sampleHostName/library/components/{id}

Updates existing component in user's organization context.


To update a component request body must contain all the properties desired for the component since this will replace existing component with current component definition. DisplayName and status are required properties.

Component status values are: -Draft -Published -Checked -Approved -Archived

Associated Entities

A component can have associated entities, e.g catalogs, application, category, manufacturer. These values should be valid Ids of existing entities.


Requires Authorization header with valid Bearer token for scope library:modify.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.


User must be an Organization Administrator for the Organization or have Write permission assigned at the organization level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.