Skip to main content
PATCH
/
api
/
invite
Send an invitation to a new user.
curl --request PATCH \
  --url https://api.example.com/api/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "roleId": 2
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

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

Body

application/json
​
email
string
required

Email address of the user to invite

Example:

"[email protected]"

​
roleId
number
required

Role ID to assign to the invited user

Example:

2

Response

200 - undefined