OMomni
Documents

Transfer document ownership

Changed on
<Warning> This endpoint is deprecated. Use the [Grant document permissions](/api/document-permissions/grant-document-permissions) and [Update document permissions](/api/document-permissions/update-document-permissions) endpoints to assign document ownership. </Warning>

Transfer ownership of a document to another user in the organization.

To successfully transfer a document:

  • The user performing the transfer must have MANAGER permissions or higher on the document
  • The new owner must be a member of the organization AND have explicit access to the document

Upon success, the following occurs:

  • The named user is granted OWNER role on the document
  • All other users with OWNER role are demoted to MANAGER permissions on the document
  • Explicit permits for the new owner are revoked, as they now have owner access
  • Content search index is updated

Note: This operation does not modify the document's creator, and does not move a restricted document out of its current folder. Transferring to the current owner is a no-op and returns success.

put/v1/documents/{documentId}/transfer-ownership

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/documents/{documentId}/transfer-ownership
  • Auth
    HTTP bearer

Path parameters

documentIdstring required

The ID of the document to transfer. To retrieve the ID, navigate to File > Document settings in the document and then click Settings. The Identifier field contains the document ID.

Request body

userIdstring required

The membership ID of the user to transfer ownership to. This must be a valid organization member who has explicit permission on the document.

Response

Document ownership transferred successfully.

Note: This response is also returned when transferring to the current owner.

successboolean

Example response

{
  "success": true
}

Changes