Create invitation

/api/invitationsPOST

Invite a Bri username to an owned note or quick link. Repeating an existing invitation is idempotent.

Authorization

bearerAuth *Bearer <token>

Send the full key as Authorization: Bearer bri_..... Token in: header

Request Bodyapplication/jsonrequired

kind *"note" | "link"

id *string

inviteeUsername *string

Min length: 1

Response

200 · Invitation result.

data *object

Show properties

invited *boolean

alreadyInvited *boolean

400 · The request body or parameter is invalid.

error *string

Human-readable error message.

401 · The bearer key is missing, malformed, revoked, or invalid.

error *string

Human-readable error message.

403 · The caller lacks the required permission or ownership.

error *string

Human-readable error message.

404 · The resource is not available to the caller.

error *string

Human-readable error message.

Ask AI about this page

Request example

curl -X POST "https://bri.fyi/api/invitations" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "note",
  "id": "string",
  "inviteeUsername": "string"
}'