Skip to main content
POST
/
v1
/
admin
/
organizations
/
{id}
/
invite
Invite member to organization (platform admin)
curl --request POST \
  --url http://localhost:3333/v1/admin/organizations/{id}/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "user@example.com",
  "role": "admin"
}
'

Path Parameters

​
id
string
required

Body

application/json
​
email
string
required

Email address of the user to invite

Example:

"user@example.com"

​
role
enum<string>
required

Role to assign to the invited member

Available options:
admin,
auditor,
employee,
contractor
Example:

"admin"

Response

201 - undefined