Projects

Change a member's role.

Make the member an editor or a viewer. The owner or an admin (403 project_owner_only for a member). 404 project_member_not_found for an account that is not a member. Audited. Scope: story:write. Free.

patch/story-projects/{projectId}/members/{userId}

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/members/{userId}
  • Auth: HTTP bearer

Request body

role'editor' | 'viewer' required

Response

The members now, and the one changed.

projectIdstring required
yourUserIdstring required

The caller's own user id.

yourRole'owner' | 'editor' | 'viewer' | 'null' nullable required

The caller's own role; null for an admin who is neither the owner nor a member.

canManageboolean required

Whether the caller may add, change or remove members: the owner, or an admin.

changedboolean required

False when nothing changed: the member already had that role, or was not a member.

Changes

No recorded changes to this operation across all 2 revisions of this API.