Skip to main content
POST
Disable a library invitation

Authorizations

Authorization
string
header
required

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_id
string
required

Invitation identifier.

Response

Successful Response

id
string
required

Stable invitation identifier.

library_id
string
required

ID of the target library.

created_by
UserSummary · object
required

Account that created this invitation.

role
enum<string>
required

Role offered to admitted members.

Available options:
viewer,
collaborator
expires_at
string<date-time>
required

Exclusive expiration instant.

max_joiners
integer
required

Fixed maximum number of distinct redemptions.

joiner_count
integer
required

Number of accounts that have redeemed this invitation, including departed members.

remaining_places
integer
required

Places remaining for new accounts; never negative.

state
enum<string>
required

Derived invitation state, with disablement taking precedence over expiration and exhaustion.

Available options:
active,
exhausted,
expired,
disabled
disabled_at
string<date-time> | null
required

When the owner disabled this invitation, or null.

created_at
string<date-time>
required

When this invitation was issued.

updated_at
string<date-time>
required

When this invitation last changed.