Skip to main content
POST
Send an invitation to join an organization

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowImplicit
Authorization URL
https://auth.xata.io/realms/xata/protocol/openid-connect/auth
Scopes1
invite:write

Path Parameters

organizationID
string
required

Unique identifier for a specific organization

Pattern: [a-zA-Z0-9_-~:]+

Body

application/json
email
string<email>
required

Email address of the user to invite

role
enum<string>

Role the user holds once they accept the invitation. Optional; when omitted, the least privileged role offered applies

Available options:
admin,
editor

Response

Invitation sent successfully