FLflorafauna-ai
Projects

Update project sharing

Changed on

Changes the project's link sharing explicitly. Set sharing_mode to restricted to unshare (every share link stops resolving), or to view or edit to open it — the response then carries the link for that mode, created if needed; edit requires the workspace plan to include editable sharing (paid_plan_required otherwise). allow_link_comments and passphrase apply to the link and are rejected while sharing is restricted. Only fields present in the body change. Returns the resulting sharing state.

patch/projects/{projectId}/sharing

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/projects/{projectId}/sharing
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier

Example:prj_abc123

Request body

sharing_mode'restricted' | 'view' | 'edit'

New link sharing mode. restricted revokes every share link; view or edit opens sharing and the response carries the link for that mode, created if needed.

allow_link_commentsboolean

Whether visitors arriving through the link may leave comments

passphrasestring nullable

A string sets or replaces the passphrase visitors must enter before the link resolves; null (or an empty string) clears it. Whitespace-only values are rejected. Omit to leave it unchanged.

Response

Sharing updated.

project_idstring required

Project identifier

workspace_idstring required

Workspace identifier

sharing_mode'restricted' | 'view' | 'edit' required

Link sharing mode: restricted (no links; members only), view (anyone with the link can view), edit (anyone with the link can edit)

is_privateboolean required

True when only the owner and the people it was shared with can see the project, rather than the whole workspace

can_manage_sharingboolean required

Whether the authenticated user may change this project's sharing

canvas_urlstring uri required

Project canvas URL

Example response

{
  "project_id": "prj_abc123",
  "workspace_id": "ws_abc123",
  "owner": {
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  },
  "members": [
    {
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "role": "editor"
    }
  ]
}

Changes

  • a8351619f225Revision changes
    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

  • e54130373b10Revision changes
    • info

      endpoint added