Issue (or replace) a tenant invitation (min tenant ADMIN)

Role may only be ADMIN or MEMBER (never OWNER). Email-send failure does NOT roll back the invitation; inviteUrl is always returned as a copy-link fallback.

Authorizations

SessionCookie

Request Body^required

application/json

object

email

required

string format: email

role

string

default: MEMBER

Allowed values: ADMIN MEMBER

Responses

201

Invitation created

application/json

object

boolean

email

string

role

string

Allowed values: ADMIN MEMBER

inviteUrl

string

emailSent

boolean

400

Invalid JSON / bad email / bad role / stale tenant

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

401

Not authorized

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

403

Needs tenant ADMIN

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

500

Failed to create invitation

application/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

1
{
2
  "error": "example",
3
  "message": "example"
4
}

POST

/api/admin/invitations

1
curl --request POST \
2
  --url https://retidal.com/api/admin/invitations \
3
  --header 'Content-Type: application/json' \
4
  --cookie trackly_session=%3CYOUR_API_KEY%3E \
5
  --data '{
6
  "email": "<string>",
7
  "role": "MEMBER"
8
}'

1
const url = 'https://retidal.com/api/admin/invitations';
2
const options = {
3
  method: 'POST',
4
  headers: {
5
    cookie: 'trackly_session=%3CYOUR_API_KEY%3E',
6
    'Content-Type': 'application/json'
7
  },
8
  body: '{"email":"<string>","role":"MEMBER"}'
9
};
10

11
try {
12
  const response = await fetch(url, options);
13
  const data = await response.json();
14
  console.log(data);
15
} catch (error) {
16
  console.error(error);
17
}

1
import requests
2

3
url = "https://retidal.com/api/admin/invitations"
4

5
payload = {
6
    "email": "<string>",
7
    "role": "MEMBER"
8
}
9
headers = {
10
    "cookie": "trackly_session=%3CYOUR_API_KEY%3E",
11
    "Content-Type": "application/json"
12
}
13

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

16
print(response.json())

1
import httpx
2
import json
3

4
url = "https://retidal.com/api/admin/invitations"
5

6
cookies = {"trackly_session": "<YOUR_API_KEY>"}
7

8
payload = json.loads("{\n  \"email\": \"<string>\",\n  \"role\": \"MEMBER\"\n}")
9

10
response = httpx.post(url, cookies=cookies, json=payload)
11

12
print(response.json())

1
package main
2

3
import (
4
  "fmt"
5
  "strings"
6
  "net/http"
7
  "io"
8
)
9

10
func main() {
11

12
  url := "https://retidal.com/api/admin/invitations"
13

14
  payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"role\": \"MEMBER\"\n}")
15

16
  req, _ := http.NewRequest("POST", url, payload)
17

18
  req.Header.Add("cookie", "trackly_session=%3CYOUR_API_KEY%3E")
19
  req.Header.Add("Content-Type", "application/json")
20

21
  res, _ := http.DefaultClient.Do(req)
22

23
  defer res.Body.Close()
24
  body, _ := io.ReadAll(res.Body)
25

26
  fmt.Println(res)
27
  fmt.Println(string(body))
28

29
}

201Invitation created

1
{
2
  "ok": true,
3
  "role": "ADMIN"
4
}

Issue (or replace) a tenant invitation (min tenant ADMIN)

Authorizations

Request Bodyrequired

Responses

201

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

500

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated