v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB
Invites

Create invite

post/api/v1/invites

Request body

expiration_hoursinteger nullable

How long the invite stays valid, in hours.

network_idsstring[] required

The networks this entity applies to.

permissions'Owner' | 'Admin' | 'Member' | 'Viewer' required
send_tostring nullable

Address to email the invite to. Omit to create a link without sending.

Response

Invite created

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}