libraries

Change a library member's role

Changed on

Change an active non-owner member's role. Repeating the same role is unchanged. An inactive membership or attempt to change the owner returns 409; retrying unchanged will not clear it.

patch/api/libraries/{library_id}/members/{user_id}

Request

  • Base URL: https://api.gumnut.ai
  • URL: https://api.gumnut.ai/api/libraries/{library_id}/members/{user_id}
  • Auth: HTTP bearer

Path parameters

library_idstring required

Library identifier.

user_idstring required

Member account identifier.

Request body

role'viewer' | 'collaborator' required

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.

Response

Successful Response

idstring required

Stable membership record identifier.

library_idstring required

Library this membership belongs to.

role'viewer' | 'collaborator' required

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.

state'active' | 'left' | 'removed' required

A member's library access state.

active grants the assigned role. left means the member departed; removed means the owner revoked access. left and removed grant no access.

joined_atstring date-time required

Most recent admission instant.

ended_atstring date-time nullable required

Most recent departure or removal instant, or null while active.

last_removed_atstring date-time nullable required

Retained owner-removal cutoff for readmission, or null.

created_atstring date-time required

When this record was created.

updated_atstring date-time required

When this record last changed.

Changes