Disable a library invitation
Prevent future admissions through this invitation without removing existing members. Repeating disablement returns the same inactive record.
Authorizations
First-party Gumnut app session (Clerk session JWT). Only the Gumnut web and mobile apps can obtain one — API keys and OAuth tokens cannot manage credentials or library sharing, so these operations are not callable with the credentials this API otherwise accepts.
Path Parameters
Invitation identifier.
Response
Successful Response
Stable invitation identifier.
ID of the target library.
Account that created this invitation.
Role offered to admitted members.
viewer, collaborator Exclusive expiration instant.
Fixed maximum number of distinct redemptions.
Number of accounts that have redeemed this invitation, including departed members.
Places remaining for new accounts; never negative.
Derived invitation state, with disablement taking precedence over expiration and exhaustion.
active, exhausted, expired, disabled When the owner disabled this invitation, or null.
When this invitation was issued.
When this invitation last changed.