Skip to main content
POST
Invite a member

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Body

application/json

Email address and role for the invite.

Invite a new member by email.

email
string<email>
required

Email address to invite.

role
enum<string>
required

Role to grant the invited member on acceptance.

Available options:
owner,
admin,
member
Example:

"member"

Response

The invite was created.

Created invite, with an optional warning when email delivery failed.

invite
object
required

A pending or historical organization invite.

Example:
warning
string

Present when the invite row was created but the invitation email could not be sent.

Example:

"Invite was created, but the invitation email could not be sent: upstream timeout."