Skip to main content
POST
Invite user to workspace

Authorizations

whilst_session
string
cookie
required

JWT session token for authenticated users

Body

application/json
email
string<email>
required

Email address of the user to invite

Example:

"colleague@acme.com"

role
enum<string>
default:member
required

Role to assign to the invited user

Available options:
admin,
member

Response

Invitation sent successfully

success
boolean
required
message
string
required
invitationId
string

WorkOS invitation ID (if available)

invitationUrl
string<uri>

Direct signup URL (fallback method)