Skip to main content
POST
Create invitation

Authorizations

Authorization
string
header
required

JWT token obtained from /api/auth/token endpoint. Token is verified using JWKS and must include a valid user identifier.

Body

application/json
email
string<email>
required
platformRole
enum<string>
required
Available options:
admin,
member,
contractor,
sales_rep
projectId
string<uuid>

Optional: Project to invite the user to

Example:

"123e4567-e89b-12d3-a456-426614174000"

projectRoleId
string<uuid>

ID of the project role to assign

Example:

"123e4567-e89b-12d3-a456-426614174001"

Response

Invitation created or skipped

invitationId
string<uuid> | null
required
email
string<email>
required
action
enum<string>
required
Available options:
invited,
skipped
reason
string