> For the complete documentation index, see [llms.txt](https://docs.flora.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flora.ai/api/reference/projects/updateprojectsharing.md).

# Update project sharing

Update project sharing with the FLORA API: PATCH /projects/{projectId}/sharing.

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.

```http
PATCH https://app.flora.ai/api/v1/projects/{projectId}/sharing
```

* **Auth:** API key as a bearer token, `Authorization: Bearer $FLORA_API_KEY`. See [Authentication](https://docs.flora.ai/api/platform/authentication.md).
* **TypeScript SDK:** `client.projects.sharing.update()`.
* **Operation ID:** `updateProjectSharing`.

## Example

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X PATCH 'https://app.flora.ai/api/v1/projects/prj_abc123/sharing' \
  -H "Authorization: Bearer $FLORA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "sharing_mode": "restricted"
}'
```

{% endtab %}

{% tab title="TypeScript SDK" %}

```typescript
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const sharing = await client.projects.sharing.update({
  projectId: 'prj_abc123',
  sharing_mode: 'restricted',
});
console.log(sharing);
```

{% endtab %}
{% endtabs %}

## Path parameters

| Name        | Type   | Required | Description                                                      |
| ----------- | ------ | -------- | ---------------------------------------------------------------- |
| `projectId` | string | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`. |

## Request body

Optional.

| Field                 | Type           | Required | Description                                                                                                                                                                                                            |
| --------------------- | -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sharing_mode`        | string         | No       | 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. One of: `restricted`, `view`, `edit`.                 |
| `allow_link_comments` | boolean        | No       | Whether visitors arriving through the link may leave comments                                                                                                                                                          |
| `passphrase`          | string or null | No       | 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. At most 200 characters. |

## Responses

### 200: Sharing updated.

| Field                       | Type             | Required | Description                                                                                                                                                                     |
| --------------------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id`                | string           | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`.                                                                                                                |
| `workspace_id`              | string           | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`.                                                                                                                |
| `sharing_mode`              | string           | Yes      | Link sharing mode: `restricted` (no links; members only), `view` (anyone with the link can view), `edit` (anyone with the link can edit). One of: `restricted`, `view`, `edit`. |
| `is_private`                | boolean          | Yes      | True when only the owner and the people it was shared with can see the project, rather than the whole workspace                                                                 |
| `can_manage_sharing`        | boolean          | Yes      | Whether the authenticated user may change this project's sharing                                                                                                                |
| `link`                      | object or null   | Yes      | The active share link. Null when sharing is restricted, no link has been created yet, or the caller may not manage sharing.                                                     |
| `link.url`                  | string (uri)     | Yes      | Link into the project. Anyone who has it gets the link's role, so treat it as a secret.                                                                                         |
| `link.role`                 | string           | Yes      | What the link grants: `guest` can view (and comment when allowed), `editor` can edit. One of: `guest`, `editor`.                                                                |
| `link.allow_comments`       | boolean          | Yes      | Whether visitors arriving through the link may leave comments                                                                                                                   |
| `link.passphrase_protected` | boolean          | Yes      | Whether visitors must enter a passphrase before the link resolves. The passphrase itself is never returned.                                                                     |
| `owner`                     | object           | Yes      | Project owner                                                                                                                                                                   |
| `owner.name`                | string           | Yes      | Display name. Example: `Ada Lovelace`.                                                                                                                                          |
| `owner.email`               | string           | Yes      | Email address. Example: `ada@example.com`.                                                                                                                                      |
| `members`                   | array of objects | Yes      | People with a seat on the project besides the owner                                                                                                                             |
| `members[].name`            | string           | Yes      | Display name. Example: `Ada Lovelace`.                                                                                                                                          |
| `members[].email`           | string           | Yes      | Email address. Example: `ada@example.com`.                                                                                                                                      |
| `members[].role`            | string           | Yes      | Role on the project. Example: `editor`.                                                                                                                                         |
| `canvas_url`                | string (uri)     | Yes      | Project canvas URL                                                                                                                                                              |

## Errors

Every error has the same body: `error.code`, `error.message`, and `error.fields` on validation errors. See [Errors](https://docs.flora.ai/api/platform/errors.md) for how to recover from each code.

| Status | Code                                         | Meaning                                                                             |
| ------ | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| 400    | `invalid_json`, `input_validation_error`     | The body isn't valid JSON, or an input failed validation (`fields` lists each one). |
| 401    | `unauthorized`, `invalid_api_key`            | The API key is missing, invalid or revoked.                                         |
| 402    | `insufficient_credits`                       | The workspace balance is too low for this request.                                  |
| 403    | `forbidden`, `paid_plan_required`            | The key can't do this, or the workspace plan doesn't include it.                    |
| 404    | `not_found`                                  | The resource doesn't exist or isn't visible to this key.                            |
| 409    | `idempotency_duplicate`, `revision_conflict` | Duplicate `Idempotency-Key` or a stale `base_revision`.                             |
| 429    | `rate_limited`                               | Too many requests. Back off and retry.                                              |
| 500    | `unknown_error`, `internal_error`            | Something failed on FLORA's side. Retry with backoff.                               |
| 503    | `temporarily_unavailable`                    | Authorization is temporarily unavailable. Retry later.                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flora.ai/api/reference/projects/updateprojectsharing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
