Skip to main content
PUT
/
v1
/
documents
/
{documentId}
/
transfer-ownership
Transfer document ownership
curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/documents/{documentId}/transfer-ownership \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "9e8719d9-276a-4964-9395-a493189a247c"
}
'
{
"success": true
}

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

documentId
string
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.

Body

application/json
userId
string
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.

success
boolean
Example:

true