Update share | Frame.io API Documentation

from frameio_experimental import FrameioExperimental
from frameio_experimental.shares import UpdateShareParamsData, UpdateShareParamsDataSortBy
import datetime
client = FrameioExperimental(
    token="YOUR_TOKEN_HERE",
)
client.shares.update(
    account_id="cf59e393-2ec2-4d1d-8dab-d9e372e649e7",
    share_id="e4c5d879-f630-46fd-bb8d-fef4bfecd7b2",
    api_version="experimental",
    data=UpdateShareParamsData(
        accent_color="#FF0000",
        access="public",
        captions_enabled=True,
        card_aspect_ratio="square",
        card_info_enabled=True,
        card_size="medium",
        description="A descriptive summary of the share",
        downloading_enabled=True,
        drm_enabled=False,
        editable_fields_enabled=True,
        enabled=True,
        expiration=datetime.datetime.fromisoformat("2026-06-17T23:51:13.243054+00:00"),
        forensic_watermark_enabled=False,
        layout="grid",
        name="Share Name",
        open_in_viewer_enabled=True,
        passphrase="as!dfj39sd(*",
        show_all_asset_versions=True,
        sort_by=UpdateShareParamsDataSortBy(
            direction="asc",
            field_definition_id="ed5b0a61-fee3-4fa8-907a-495b9cd16165",
        ),
        theme="dark",
        thumbnail_scale="fill",
        title_line_count=1,
        transcripts_enabled=True,
        visible_field_definition_ids=[],
        watermark_enabled=True,
    ),
)

{
  "data": {
    "enabled": true,
    "access": "public",
    "last_viewed_at": "2024-03-02T21:19:24.828948Z",
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "editable_fields_enabled": false,
    "commenting_enabled": true,
    "description": "Description of share",
    "sort_by": {
      "direction": "asc",
      "field_definition_id": "58babe99-4344-4f5c-81ba-e7cedeca1536"
    },
    "created_at": "2024-02-02T21:19:24.828948Z",
    "forensic_watermark_enabled": false,
    "name": "Test Share",
    "collection_id": "7a4e29f6-8f34-4ec4-9102-1b8f436623f8",
    "short_url": "https://f.io/GGa9wPw5",
    "drm_enabled": false,
    "watermark_enabled": true,
    "featured_field_definition_id": "6c8cc20e-afa4-4fbc-bf4d-2a46348d6b34",
    "downloading_enabled": true,
    "id": "fac3365b-03d3-4293-be3b-86dce03c4236",
    "expiration": "2026-06-17T23:51:13.243054Z",
    "visible_field_definition_ids": [
      "b68e4d61-c4d6-4199-8a05-6cfa9fb3ce40"
    ],
    "card_info_enabled": true,
    "icons_visible_on_list": true,
    "theme": "dark",
    "card_aspect_ratio": "square",
    "passphrase": "as!dfj39sd(*",
    "list_row_size": "small",
    "card_size": "medium",
    "reel_card_aspect_ratio": "square",
    "show_asset_name_in_reel_layout": false,
    "captions_enabled": true,
    "transcripts_enabled": true,
    "reel_card_fit_image": false,
    "open_in_viewer_enabled": true,
    "accent_color": "#FF0000",
    "layout": "grid",
    "show_all_asset_versions": true,
    "name_column_width": null,
    "thumbnail_scale": "fill",
    "title_line_count": 1
  }
}

Update share.
Rate Limits: 10 calls per 1.00 minute(s) per account_user

Authentification

AuthorizationBearer

Authentification bearer de la forme Bearer <token>, où token est votre jeton d’authentification.

Paramètres de chemin

account_idstringRequis

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with adobe: (e.g. adobe:<adobe_org_id> for an account, adobe:<adobe_asset_id> for a project or folder, adobe:adobe:<adobe_asset_id>|<version>` for a file asset).

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).

share_idstringRequisformat: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

Requête

Share params body

dataobjectRequis

En-têtes de réponse

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Réponse

dataobject

Erreurs

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error