> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.staging.frame.io/platform/v4/api-reference/shares/update/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.staging.frame.io/_mcp/server.

# Update share

PATCH https://api.frame.io/v4/accounts/{account_id}/shares/{share_id}
Content-Type: application/json

Update share. Rate Limits: 10 calls per 1.00 minute(s) per account\_user

Reference: https://developer.staging.frame.io/platform/api-reference/shares/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Path parameters

- `account_id` (string, required)
- `share_id` (string, required)

### Body (application/json)

This endpoint expects an UpdateShareParams.

- `data` (UpdateShareParamsData, required)

## Response

### 200

OK

- `data` (Share, required)

## Errors

### 400 Bad Request Error

Bad Request

- `errors` (list of BadRequestErrorsItems, required)

### 401 Unauthorized Error

Unauthorized

- `errors` (list of UnauthorizedErrorsItems, required)

### 403 Forbidden Error

Forbidden

- `errors` (list of ForbiddenErrorsItems, required)

### 404 Not Found Error

Not Found

- `errors` (list of NotFoundErrorsItems, required)

### 422 Unprocessable Entity Error

Unprocessable Entity

- `errors` (list of UnprocessableEntityErrorsItems, required)

### 429 Too Many Requests Error

Too Many Requests

- `errors` (list of TooManyRequestsErrorsItems, required)

## Types

### UpdateShareParamsData

- `access` (enum, optional)
  - Allowed values: `public`, `secure`
- `description` (string, optional, nullable) — Share description - NOTE: Requires feature custom_branded_shares
- `downloading_enabled` (boolean, optional)
- `expiration` (string, optional, nullable) — Expiration timestamp
- `name` (string, optional, nullable) — Share Name (must include at least one non-whitespace character and no line breaks)
- `passphrase` (string, optional, nullable) — Passphrase to access share, if passphrase is required and not given it will be generated

### Share

- `access` (enum, required)
  - Allowed values: `public`, `secure`
- `collection_id` (string, required) — Collection ID
- `commenting_enabled` (boolean, required)
- `created_at` (string, required) — Creation timestamp
- `description` (string, required, nullable) — Share description
- `downloading_enabled` (boolean, required)
- `enabled` (boolean, required)
- `expiration` (string, required, nullable) — Expiration timestamp
- `id` (string, required) — Share ID
- `last_viewed_at` (string, required, nullable) — Last viewed timestamp
- `name` (string, required, nullable) — Share name
- `short_url` (string, required, nullable) — Share URL
- `updated_at` (string, required) — Update timestamp
- `passphrase` (string, optional, nullable) — Passphrase to access share, if passphrase is required and not given it will be generated

### BadRequestErrorsItems

- `detail` (string, required)
- `source` (BadRequestErrorsItemsSource, optional)
- `title` (string, optional)

### UnauthorizedErrorsItems

- `detail` (string, required)
- `source` (UnauthorizedErrorsItemsSource, optional)
- `title` (string, optional)

### ForbiddenErrorsItems

- `detail` (string, required)
- `source` (ForbiddenErrorsItemsSource, optional)
- `title` (string, optional)

### NotFoundErrorsItems

- `detail` (string, required)
- `source` (NotFoundErrorsItemsSource, optional)
- `title` (string, optional)

### UnprocessableEntityErrorsItems

- `detail` (string, required)
- `source` (UnprocessableEntityErrorsItemsSource, optional)
- `title` (string, optional)

### TooManyRequestsErrorsItems

- `detail` (string, required)
- `source` (TooManyRequestsErrorsItemsSource, optional)
- `title` (string, optional)

### BadRequestErrorsItemsSource

- `pointer` (string, optional)

### UnauthorizedErrorsItemsSource

- `pointer` (string, optional)

### ForbiddenErrorsItemsSource

- `pointer` (string, optional)

### NotFoundErrorsItemsSource

- `pointer` (string, optional)

### UnprocessableEntityErrorsItemsSource

- `pointer` (string, optional)

### TooManyRequestsErrorsItemsSource

- `pointer` (string, optional)

## Examples

**Request**

```json
{
  "data": {
    "access": "public",
    "description": "A descriptive summary of the share",
    "downloading_enabled": true,
    "expiration": "2025-10-24T22:42:23.690532Z",
    "name": "Share Name",
    "passphrase": "as!dfj39sd(*"
  }
}
```

**Response**

```json
{
  "data": {
    "access": "public",
    "collection_id": "b3252929-2bd2-4b7b-9db2-7e7e8f798284",
    "commenting_enabled": true,
    "created_at": "2024-02-02T21:19:24.828948Z",
    "description": "Description of share",
    "downloading_enabled": true,
    "enabled": true,
    "expiration": "2025-10-24T22:42:23.690532Z",
    "id": "e92216a0-4497-4980-9f35-4c480a926139",
    "last_viewed_at": "2024-03-02T21:19:24.828948Z",
    "name": "Test Share",
    "short_url": "https://f.io/GGa9wPw5",
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "passphrase": "as!dfj39sd(*"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118"

payload = { "data": {
        "access": "public",
        "description": "A descriptive summary of the share",
        "downloading_enabled": True,
        "expiration": "2025-10-24T22:42:23.690532Z",
        "name": "Share Name",
        "passphrase": "as!dfj39sd(*"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"data":{"access":"public","description":"A descriptive summary of the share","downloading_enabled":true,"expiration":"2025-10-24T22:42:23.690532Z","name":"Share Name","passphrase":"as!dfj39sd(*"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118"

	payload := strings.NewReader("{\n  \"data\": {\n    \"access\": \"public\",\n    \"description\": \"A descriptive summary of the share\",\n    \"downloading_enabled\": true,\n    \"expiration\": \"2025-10-24T22:42:23.690532Z\",\n    \"name\": \"Share Name\",\n    \"passphrase\": \"as!dfj39sd(*\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"access\": \"public\",\n    \"description\": \"A descriptive summary of the share\",\n    \"downloading_enabled\": true,\n    \"expiration\": \"2025-10-24T22:42:23.690532Z\",\n    \"name\": \"Share Name\",\n    \"passphrase\": \"as!dfj39sd(*\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"access\": \"public\",\n    \"description\": \"A descriptive summary of the share\",\n    \"downloading_enabled\": true,\n    \"expiration\": \"2025-10-24T22:42:23.690532Z\",\n    \"name\": \"Share Name\",\n    \"passphrase\": \"as!dfj39sd(*\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118', [
  'body' => '{
  "data": {
    "access": "public",
    "description": "A descriptive summary of the share",
    "downloading_enabled": true,
    "expiration": "2025-10-24T22:42:23.690532Z",
    "name": "Share Name",
    "passphrase": "as!dfj39sd(*"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"access\": \"public\",\n    \"description\": \"A descriptive summary of the share\",\n    \"downloading_enabled\": true,\n    \"expiration\": \"2025-10-24T22:42:23.690532Z\",\n    \"name\": \"Share Name\",\n    \"passphrase\": \"as!dfj39sd(*\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": [
    "access": "public",
    "description": "A descriptive summary of the share",
    "downloading_enabled": true,
    "expiration": "2025-10-24T22:42:23.690532Z",
    "name": "Share Name",
    "passphrase": "as!dfj39sd(*"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/c7da3fe6-0936-4e91-902d-60549f6bf11f/shares/adf66f8c-87c8-4f8c-a148-84c3eaa98118")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```