Skip to main content
POST
/
document
/
invite-users
Invite users to documents
curl --request POST \
  --url https://app.myhero.so/document/invite-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentIds": [
    "<string>"
  ],
  "emails": [
    "jsmith@example.com"
  ],
  "role": "owner"
}
'
{
  "data": {
    "invitationsSent": 123,
    "documentsInvited": 123,
    "usersInvited": 123
  }
}

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.

Invites one or more users by emails to one or more documentIds at the specified role. Returns counts of invitations sent, documents invited, and users invited.

Authorizations

​
Authorization
string
header
required

HERO personal access token

Body

application/json
​
documentIds
string[]
required
Minimum array length: 1
Minimum string length: 1
​
emails
string<email>[]
required
Minimum array length: 1
​
role
enum<string>
required
Available options:
owner,
admin,
member,
editor,
viewer

Response

200 response

​
data
object
required