Skip to content
DonorIntel Knowledge Base

Send Invitation As Superadmin

POST
/v1/invitations/superadmin

Superadmin sends an invitation on behalf of any WorkOS org. Used for support onboarding, migrating customers, or provisioning initial admins.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
workos_org_id
required
Workos Org Id
string

Request Body required

Section titled “Request Body required ”
InvitationSendRequest

Request body for sending a WorkOS invitation to join a tenant.

object
email
required
Email

Email address of the person to invite.

string format: email
role_slug
Role Slug

WorkOS role slug to assign. Defaults to ‘member’.

string
default: member
expires_in_days
Expires In Days

How many days until the invitation expires.

integer
default: 7 >= 1 <= 90

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

InvitationRead

Projection of a WorkOS invitation object.

object
id
required
Id
string
email
required
Email
string
state
required
State
string
role_slug
Any of:
string
organization_id
Any of:
string
created_at
Any of:
string format: date-time
expires_at
Any of:
string format: date-time
accepted_at
Any of:
string format: date-time
revoked_at
Any of:
string format: date-time
inviter_user_id
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object