Skip to main content
POST
/
organizations
/
{organizationID}
/
invitations
Send an invitation to join an organization
curl --request POST \
  --url https://api.xata.tech/organizations/{organizationID}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'
{
  "message": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

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

Response

Invitation sent successfully