Make a single-use invite link with a role (REQ-081). The URL appears one time.

POST

/admin/invites

curl --request POST \
  --url https://example.com/api/v1/admin/invites \
  --header 'Content-Type: application/json' \
  --data '{ "role": "admin" }'

Request Body^required

Media typeapplication/json

object

role

required

string

Allowed values: admin member

Responses

200

The invite and its link.

Media typeapplication/json

object

url

required

string

invite

required

object

id

required

string format: uuid

role

required

string

Allowed values: admin member

expires_at

required

string format: date-time

created_by

required

string

created_at

required

string format: date-time

used_by

string

adopt

The frontmatter keys the main doc does not name, and the values a review used for them (REQ-135). Absent when the doc names both.

object

type

string

size

string

status

required

string

Allowed values: pending used revoked expired

Example

{
  "invite": {
    "role": "admin",
    "status": "pending"
  }
}

default

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

instance

string

code

required

A stable machine-readable error code.

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}