Skip to main content
Invite a user to a project by email

Path Parameters

project_id
string<uuid>
required

Body

application/json
email
string
required

Email address of the person to invite.

project_role_id
string
required

ID of the project role to assign.

Response

Successful Response

Result of adding a user to an organization by email.

Returned by the service and used verbatim as the route's response model.

user_id
string
required

ID of the (invited or pre-existing) user that was added.

invite_sent
boolean
required

True when the email was not registered yet and an invitation email was dispatched. False when the email already belonged to a registered user, in which case the existing account was linked and no email was sent.

already_member
boolean
default:false

True when the user already belonged to the organization. Their membership, including its role, was left unchanged.

role_name
string | null

Organization role the user holds after the request, when the endpoint reports it.