Invite a user by email - Albus Documentation

Invite a user by email

curl --request POST \
  --url https://albus.sh/api/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'

import requests

url = "https://albus.sh/api/invites"

payload = { "email": "jsmith@example.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com'})
};

fetch('https://albus.sh/api/invites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "email": "<string>",
  "role": "<string>",
  "organization_id": "<string>"
}

{
  "message": "Invalid request parameters"
}

{
  "message": "Invalid or expired token"
}

{
  "message": "Idempotency key reused with a different request body"
}

POST

/

invites

Invite a user by email

curl --request POST \
  --url https://albus.sh/api/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com"
}
'

import requests

url = "https://albus.sh/api/invites"

payload = { "email": "jsmith@example.com" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com'})
};

fetch('https://albus.sh/api/invites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "email": "<string>",
  "role": "<string>",
  "organization_id": "<string>"
}

{
  "message": "Invalid request parameters"
}

{
  "message": "Invalid or expired token"
}

{
  "message": "Idempotency key reused with a different request body"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

email

string<email>

required

Email address of the person to invite.

role

enum<string>

Role to grant the invitee. Defaults to admin when inviting to a new organization and member when inviting into an existing one.

Available options:

admin,

member

organization_id

string

Organization to invite the user into (e.g. "42"). Omit to create a new organization for the user on their first sign-in.

Response

Created

id

string

required

Invitation identifier

email

string

required

Invited email address

role

string

required

Role the invitee will be granted

organization_id

string

Organization the invitee will join. Absent when the invitation creates a new organization on first sign-in.

⌘I