Projects

Share the project with an existing account, by email.

An editor does everything with the project's content except delete the project or manage its members, and spends their own credits; a viewer reads. The owner or an admin: 403 project_owner_only for a member. Only a product project can be shared for now (409 project_members_product_only). 404 project_member_not_found when no account has the email (the person must sign up first). Adding a member again sets their role (changed: false when it was already that). Audited. Scope: story:write. Free.

post/story-projects/{projectId}/members

Request

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

Request body

emailstring required

The email address of an existing account.

role'editor' | 'viewer' required

editor or viewer.

Response

The members now, and the one added.

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 1 revision of this API.