Invites API

Older endpoint notes

Rendered from ProjectInfo/api-docs/api/invites.md on docs/encryption-modes-spec. These notes predate the REST API reference, which is canonical wherever the two overlap. They are published because they still cover endpoints the reference does not yet document — check shapes against the reference and the spec errata.

---

POST /api/servers/{serverID}/invites

Create an invite link.

Auth: Required
Request:

{
  "max_uses": 0,
  "expires_in": 86400
}

• max_uses = 0 — unlimited
• expires_in = 0 — never expires (value in seconds)

Response 201: Invite

---

GET /api/invites/{code}

Fetch invite details. No auth required — public preview for join screens.

Response 200: Invite
Errors: 404 (not found or expired)

---

POST /api/invites/{code}

Accept/use an invite. Adds the authenticated user to the server.

Auth: Required
Response 200: Server (the joined server)
Errors: 404 (not found), 409 (already a member), 403 (banned)

Invite URL format used in the client: https://zipp.chat/join/{code}