Skip to main content
POST
/
document
/
transfer
/
create
Create a document transfer
curl --request POST \
  --url https://app.myhero.so/document/transfer/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "documentIds": [
    "<string>"
  ],
  "rootDocumentId": "<string>",
  "senderProjectId": "<string>"
}
'
{
  "data": true
}

Documentation Index

Fetch the complete documentation index at: https://developers.myhero.so/llms.txt

Use this file to discover all available pages before exploring further.

Initiates a transfer of one or more documents to another user by email. Creates a transfer record and sends an email notification; if the recipient is not yet registered, an invitation link is included in the email.

Authorizations

​
Authorization
string
header
required

HERO personal access token

Body

application/json
​
email
string<email>
required
​
documentIds
string[]
required
Minimum array length: 1
Minimum string length: 1
​
rootDocumentId
string
required
Minimum string length: 1
​
senderProjectId
string
required
Minimum string length: 1

Response

200 response

​
data
enum<boolean>
required
Available options:
true