AviatoAviato
DeveloperAPI ReferenceInvites

/api/invites

POST
/api/invites

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/invites" \  -H "Content-Type: application/json" \  -d '{}'
{
  "invite": {
    "id": "string",
    "token": "string",
    "role": "string",
    "libraryAccess": [
      {
        "libraryId": "string",
        "maxRating": "string"
      }
    ],
    "groupIds": [
      "string"
    ],
    "maxUses": 0,
    "useCount": 0,
    "expiresAt": "string",
    "createdBy": "string",
    "createdAt": "string"
  },
  "url": "string",
  "externallyReachable": true
}
{
  "error": "string"
}