Skip to main content
POST
/
auth
/
invite
Invite a user to join a team
curl --request POST \
  --url https://backyard.posthoot.com/api/v1/auth/invite \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "name": "<string>",
  "role": "MEMBER"
}'
{}

Body

application/json

Send an invitation email to a user to join a team

​
email
string
required
​
name
string
required
Minimum length: 2
​
role
enum<string>
default:MEMBER
required
Available options:
MEMBER,
ADMIN,
SUPER_ADMIN

Response

Invitation sent successfully

​
{key}
string