Skip to content
Savorum API

Create an invitation

POST
/api/v1/libraries/{id}/invitations
curl --request POST \
  --url http://127.0.0.1:8080/api/v1/libraries/example/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "days": 1, "hint": "example", "role": "viewer" }'

Returns the link secret once. Library ownership or instance administration required. Browser session and CSRF protection are required for mutations, except invited local registration. Invitation secrets are returned once and must never be logged.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
days
integer format: int64
>= 1 <= 30
hint
string
role
required
string
Allowed values: viewer editor owner

Responses

Section titled “Responses”

200

Section titled “200”

Completed

Media typeapplication/json
object
invitation
required
object
accepted_at
required
integer | null format: int64
created_at
required
integer format: int64
creator
required
string
expires_at
required
integer format: int64
hint
required
string
id
required
string
library_id
required
string
revoked_at
required
integer | null format: int64
role
required
string
key
additional properties
any
token
required
string
key
additional properties
any
Examplegenerated
{
  "invitation": {
    "accepted_at": 1,
    "created_at": 1,
    "creator": "example",
    "expires_at": 1,
    "hint": "example",
    "id": "example",
    "library_id": "example",
    "revoked_at": 1,
    "role": "example"
  },
  "token": "example"
}

401

Section titled “401”

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}