Download API definition:

PUT https://sampleHostName/library/catalogs/{catalogId}/documents/{documentId}

Updates a catalog document in user's organization context.


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

Document purpose values are: -Thumbnail -Reference


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.