Documents

Transfer document ownership

Changed on

Deprecated. Ownership is a content role: grant a user the OWNER role via the permissions endpoint instead. This endpoint grants OWNER to the named user and demotes every other user holding OWNER on the document itself to MANAGER. Ownership inherited from an ancestor folder is untouched.

put/api/v1/documents/{identifier}/transfer-ownership

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents/{identifier}/transfer-ownership
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Request body

userIdstring uuid required

User ID of the new owner

Response

Ownership transferred successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}

Changes