> ## Documentation Index > Fetch the complete documentation index at: https://docs.gumnut.ai/llms.txt > Use this file to discover all available pages before exploring further. # Disable a library invitation > Prevent future admissions through this invitation without removing existing members. Repeating disablement returns the same inactive record. ## OpenAPI ````yaml https://api.gumnut.ai/openapi.json post /api/libraries/invitations/{invitation_id}/disable openapi: 3.1.0 info: title: Gumnut API description: >- The Gumnut API manages photo and video libraries: upload and organize assets, search by content, group detected faces into people, and curate albums and stacks. Headless clients authenticate by sending either a Gumnut API key (`apikey_...`) or an OAuth access token as a Bearer token in the `Authorization` header. The Gumnut web and mobile apps sign in with a first-party session (Clerk session JWT) instead, which is also the only credential that can manage API keys and library sharing. contact: name: Gumnut url: https://www.gumnut.ai/contact version: 1.0.0 servers: - url: https://api.gumnut.ai description: Production security: - apiKeyAuth: [] - oauthJwtAuth: [] tags: - name: assets description: >- Photos and videos in a library: upload, list and filter, update metadata, trash and restore. - name: search description: >- Content-based search over a library's assets, with album, person, date, and location filters. - name: albums description: User-curated collections of assets. - name: album-assets description: Link records connecting albums to their member assets. - name: stacks description: >- Groups of related shots of the same moment, presented as a single unit with a cover asset. - name: people description: Named people, each built from clustered faces. - name: faces description: Detected faces and their assignment to people. - name: libraries description: Top-level containers that own assets, albums, people, and everything else. - name: library-invitations description: First-party invitation management and admission for photo libraries. - name: events description: Change-event feed for keeping client state in sync. - name: tasks description: Status of background processing tasks. - name: users description: The authenticated user's profile. - name: api-keys description: >- Create and manage Gumnut API keys. Requires a first-party Gumnut app session — API keys and OAuth tokens cannot manage credentials. - name: oauth description: OAuth flow endpoints for obtaining and refreshing access tokens. - name: server description: Service health. paths: /api/libraries/invitations/{invitation_id}/disable: post: tags: - library-invitations summary: Disable a library invitation description: >- Prevent future admissions through this invitation without removing existing members. Repeating disablement returns the same inactive record. operationId: disable_library_invitation parameters: - name: invitation_id in: path required: true schema: type: string description: Invitation identifier. title: Invitation Id description: Invitation identifier. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InvitationResponse' '401': description: Missing, invalid, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The credentials are valid but not authorized for this operation — for example an API key whose action or library scope excludes it, or a credential type this operation does not accept. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/SharingErrorResponse' '409': description: >- Clerk sign-in could not be associated with the existing account. Resolve the identity conflict before retrying sign-in; repeated requests with unchanged verification and identity state will not resolve it. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/SharingErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' '429': description: >- Rate limit exceeded. Retry after the interval in the `Retry-After` header. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: >- Authentication provider temporarily unavailable. Retry sign-in later. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ErrorResponse' - $ref: '#/components/schemas/SharingErrorResponse' security: - clerkSession: [] components: schemas: InvitationResponse: properties: id: type: string title: Id description: Stable invitation identifier. library_id: type: string title: Library Id description: ID of the target library. created_by: $ref: '#/components/schemas/UserSummary' description: Account that created this invitation. role: $ref: '#/components/schemas/LibraryMemberRole' description: Role offered to admitted members. expires_at: type: string format: date-time title: Expires At description: Exclusive expiration instant. max_joiners: type: integer title: Max Joiners description: Fixed maximum number of distinct redemptions. joiner_count: type: integer title: Joiner Count description: >- Number of accounts that have redeemed this invitation, including departed members. remaining_places: type: integer title: Remaining Places description: Places remaining for new accounts; never negative. state: type: string enum: - active - exhausted - expired - disabled title: State description: >- Derived invitation state, with disablement taking precedence over expiration and exhaustion. disabled_at: anyOf: - type: string format: date-time - type: 'null' title: Disabled At description: When the owner disabled this invitation, or null. created_at: type: string format: date-time title: Created At description: When this invitation was issued. updated_at: type: string format: date-time title: Updated At description: When this invitation last changed. type: object required: - id - library_id - created_by - role - expires_at - max_joiners - joiner_count - remaining_places - state - disabled_at - created_at - updated_at title: InvitationResponse ErrorResponse: title: ErrorResponse type: object properties: detail: title: Detail type: string description: Human-readable explanation of the error. required: - detail SharingErrorResponse: title: SharingErrorResponse type: object properties: detail: type: string description: Human-readable explanation of the library-sharing failure. code: type: string description: Stable library-sharing failure code. required: - detail - code UnprocessableEntityResponse: title: UnprocessableEntityResponse type: object properties: detail: title: Detail description: >- A semantic validation message or structured request-validation errors. oneOf: - type: string description: Human-readable semantic validation message. - type: array items: $ref: '#/components/schemas/ValidationError' description: Structured request-validation errors. required: - detail UserSummary: properties: id: type: string title: Id description: User identifier display_name: anyOf: - type: string - type: 'null' title: Display Name description: Public display name, when available type: object required: - id - display_name title: UserSummary LibraryMemberRole: type: string enum: - viewer - collaborator title: LibraryMemberRole description: >- Non-owner library permissions. viewer reads library content. collaborator also edits and organizes content, including trash and restore. Neither administers members or permanently deletes photos. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: apiKeyAuth: type: http scheme: bearer description: >- Gumnut API key (`apikey_...`) sent as a Bearer token in the `Authorization` header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it. oauthJwtAuth: type: http scheme: bearer bearerFormat: JWT description: >- Short-lived JWT obtained from the OAuth token exchange, sent as a Bearer token in the `Authorization` header. clerkSession: type: http scheme: bearer bearerFormat: JWT description: >- 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. ````