reference.md

# Reference
## Token
<details><summary><code>client.token.<a href="src/webflow/token/client.py">authorized_by</a>() -> AuthorizedUser</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Information about the Authorized User

Required Scope | `authorized_user:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.token.authorized_by()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.token.<a href="src/webflow/token/client.py">introspect</a>() -> Authorization</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Information about the authorization token

<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.token.introspect()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites
<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">create</a>(...) -> Site</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope | `workspace:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.create(
    workspace_id="580e63e98c9a982ac9b8b741",
    name="The Hitchhiker\'s Guide to the Galaxy",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**workspace_id:** `str` — Unique identifier for a Workspace
    
</dd>
</dl>

<dl>
<dd>

**name:** `str` — The name of the site
    
</dd>
</dl>

<dl>
<dd>

**template_name:** `typing.Optional[str]` — The workspace or marketplace template to use
    
</dd>
</dl>

<dl>
<dd>

**parent_folder_id:** `typing.Optional[str]` — MegaDodo Publications - Potential Book Ideas
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">list</a>() -> Sites</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List of all sites the provided access token is able to access.

Required scope | `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.list()

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">get</a>(...) -> Site</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get details of a site.

Required scope | `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.get(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope | `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.delete(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">update</a>(...) -> Site</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope | `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.update(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — The name of the site
    
</dd>
</dl>

<dl>
<dd>

**parent_folder_id:** `typing.Optional[str]` — The parent folder ID of the site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">get_custom_domain</a>(...) -> Domains</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of all custom domains related to site.

Required scope | `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.get_custom_domain(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.<a href="src/webflow/sites/client.py">publish</a>(...) -> SitesPublishResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Publishes a site to one or more more domains.

To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint.

You must include at least one of the `customDomains` or `publishToWebflowSubdomain` properties in the request body.

<Note title="Rate limit: 1 publish per minute">This endpoint has a specific rate limit of one successful publish queue per minute.</Note>

Required scope | `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.publish(
    site_id="580e63e98c9a982ac9b8b741",
    custom_domains=[
        "660c6449dd97ebc7346ac629",
        "660c6449dd97ebc7346ac62f"
    ],
    publish_to_webflow_subdomain=False,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**custom_domains:** `typing.Optional[typing.List[str]]` — Array of Custom Domain IDs to publish
    
</dd>
</dl>

<dl>
<dd>

**publish_to_webflow_subdomain:** `typing.Optional[bool]` — Choice of whether to publish to the default Webflow Subdomain
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Collections
<details><summary><code>client.collections.<a href="src/webflow/collections/client.py">list</a>(...) -> CollectionList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List of all Collections within a Site.

Required scope | `cms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.list(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.<a href="src/webflow/collections/client.py">create</a>(...) -> Collection</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a Collection for a site with collection fields.

Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens.

Required scope | `cms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, StaticField
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.create(
    site_id="580e63e98c9a982ac9b8b741",
    display_name="Blog Posts",
    singular_name="Blog Post",
    slug="posts",
    fields=[
        StaticField(
            is_required=True,
            type="PlainText",
            display_name="Title",
            help_text="The title of the blog post",
        ),
        StaticField(
            is_required=True,
            type="RichText",
            display_name="Content",
            help_text="The content of the blog post",
        ),
        StaticField(
            is_required=True,
            type=,
            display_name="Author",
            help_text="The author of the blog post",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**display_name:** `str` — Name of the collection. Each collection name must be distinct.
    
</dd>
</dl>

<dl>
<dd>

**singular_name:** `str` — Singular name of each item.
    
</dd>
</dl>

<dl>
<dd>

**slug:** `typing.Optional[str]` — Part of a URL that identifier
    
</dd>
</dl>

<dl>
<dd>

**fields:** `typing.Optional[typing.List[FieldCreate]]` — An array of custom fields to add to the collection
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.<a href="src/webflow/collections/client.py">get</a>(...) -> Collection</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get the full details of a collection from its ID.

Required scope | `cms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.get(
    collection_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.<a href="src/webflow/collections/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a collection using its ID.

Required scope | `cms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.delete(
    collection_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Pages
<details><summary><code>client.pages.<a href="src/webflow/pages/client.py">list</a>(...) -> PageList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List of all pages for a site.

Required scope | `pages:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.list(
    site_id="580e63e98c9a982ac9b8b741",
    locale_id="65427cf400e02b306eaa04a0",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pages.<a href="src/webflow/pages/client.py">get_metadata</a>(...) -> Page</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get metadata information for a single page.

Required scope | `pages:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.get_metadata(
    page_id="63c720f9347c2139b248e552",
    locale_id="65427cf400e02b306eaa04a0",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pages.<a href="src/webflow/pages/client.py">update_page_settings</a>(...) -> Page</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update Page-level metadata, including SEO and Open Graph fields.

Required scope | `pages:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
from webflow.pages import PageMetadataWriteSeo, PageMetadataWriteOpenGraph

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.update_page_settings(
    page_id="63c720f9347c2139b248e552",
    locale_id="65427cf400e02b306eaa04a0",
    title="Guide to the Galaxy",
    slug="guide-to-the-galaxy",
    seo=PageMetadataWriteSeo(
        title="The Ultimate Hitchhiker\'s Guide to the Galaxy",
        description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.",
    ),
    open_graph=PageMetadataWriteOpenGraph(
        title="Explore the Cosmos with The Ultimate Guide",
        title_copied=False,
        description="Dive deep into the mysteries of the universe with your guide to everything galactic.",
        description_copied=False,
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**title:** `typing.Optional[str]` — Title for the page
    
</dd>
</dl>

<dl>
<dd>

**slug:** `typing.Optional[str]` 

Slug for the page.


**Note:** Updating slugs in secondary locales is only supported in <a href="https://webflow.com/localization">Advanced and Enterprise localization add-on plans.</a>
    
</dd>
</dl>

<dl>
<dd>

**seo:** `typing.Optional[PageMetadataWriteSeo]` — SEO-related fields for the Page
    
</dd>
</dl>

<dl>
<dd>

**open_graph:** `typing.Optional[PageMetadataWriteOpenGraph]` — Open Graph fields for the Page
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pages.<a href="src/webflow/pages/client.py">get_content</a>(...) -> Dom</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get text and component instance content from a static page.

<Badge intent="info">Localization</Badge>

Required scope | `pages:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.get_content(
    page_id="63c720f9347c2139b248e552",
    locale_id="65427cf400e02b306eaa04a0",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pages.<a href="src/webflow/pages/client.py">update_static_content</a>(...) -> UpdateStaticContentResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request.

Before making updates:
1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types.
2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.
3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.

<Note>
  This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
</Note>

Required scope | `pages:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, TextNodeWrite
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.update_static_content(
    page_id="63c720f9347c2139b248e552",
    locale_id="localeId",
    nodes=[
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623",
            text="<h1>The Hitchhiker\'s Guide to the Galaxy</h1>",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627",
            text="<div><h3>Don\'t Panic!</h3><p>Always know where your towel is.</p></div>",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `str` — The locale identifier.
    
</dd>
</dl>

<dl>
<dd>

**nodes:** `typing.List[PageDomWriteNodesItem]` — List of DOM Nodes with the new content that will be updated in each node.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Components
<details><summary><code>client.components.<a href="src/webflow/components/client.py">list</a>(...) -> ComponentList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List of all components for a site.

Required scope | `components:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.components.list(
    site_id="580e63e98c9a982ac9b8b741",
    branch_id="68026fa68ef6dc744c75b833",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.<a href="src/webflow/components/client.py">get_content</a>(...) -> ComponentDom</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances.
To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.

<Note>If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.</Note>

Required scope | `components:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.components.get_content(
    site_id="580e63e98c9a982ac9b8b741",
    component_id="8505ba55-ef72-629e-f85c-33e4b703d48b",
    locale_id="65427cf400e02b306eaa04a0",
    branch_id="68026fa68ef6dc744c75b833",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**component_id:** `str` — Unique identifier for a Component
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.<a href="src/webflow/components/client.py">update_content</a>(...) -> ComponentsUpdateContentResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request.

Before making updates:
1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types.
2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint.
3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.

<Note>
  This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail.
</Note>

Required scope | `components:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, TextNodeWrite
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.components.update_content(
    site_id="580e63e98c9a982ac9b8b741",
    component_id="8505ba55-ef72-629e-f85c-33e4b703d48b",
    locale_id="65427cf400e02b306eaa04a0",
    branch_id="68026fa68ef6dc744c75b833",
    nodes=[
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623",
            text="<h1>The Hitchhiker\'s Guide to the Galaxy</h1>",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627",
            text="<div><h3>Don\'t Panic!</h3><p>Always know where your towel is.</p></div>",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671",
        ),
        TextNodeWrite(
            node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**component_id:** `str` — Unique identifier for a Component
    
</dd>
</dl>

<dl>
<dd>

**nodes:** `typing.List[ComponentDomWriteNodesItem]` — List of DOM Nodes with the new content that will be updated in each node.
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.<a href="src/webflow/components/client.py">get_properties</a>(...) -> ComponentProperties</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get the default property values of a component definition.

<Note>If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale.</Note>

Required scope | `components:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.components.get_properties(
    site_id="580e63e98c9a982ac9b8b741",
    component_id="8505ba55-ef72-629e-f85c-33e4b703d48b",
    locale_id="65427cf400e02b306eaa04a0",
    branch_id="68026fa68ef6dc744c75b833",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**component_id:** `str` — Unique identifier for a Component
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.<a href="src/webflow/components/client.py">update_properties</a>(...) -> ComponentsUpdatePropertiesResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the default property values of a component definition in a specificed locale.

Before making updates:
1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale.
2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales.

<Note>The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error.</Note>

Required scope | `components:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
from webflow.components import ComponentPropertiesWritePropertiesItem

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.components.update_properties(
    site_id="580e63e98c9a982ac9b8b741",
    component_id="8505ba55-ef72-629e-f85c-33e4b703d48b",
    locale_id="65427cf400e02b306eaa04a0",
    branch_id="68026fa68ef6dc744c75b833",
    properties=[
        ComponentPropertiesWritePropertiesItem(
            property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623",
            text="The Hitchhiker’s Guide to the Galaxy",
        ),
        ComponentPropertiesWritePropertiesItem(
            property_id="a245c12d-995b-55ee-5ec7-aa36a6cad627",
            text="<div><h3>Dont Panic!</h3><p>Always know where your towel is.</p></div>",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**component_id:** `str` — Unique identifier for a Component
    
</dd>
</dl>

<dl>
<dd>

**properties:** `typing.List[ComponentPropertiesWritePropertiesItem]` — A list of component properties to update within the specified secondary locale.
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Scripts
<details><summary><code>client.scripts.<a href="src/webflow/scripts/client.py">list</a>(...) -> RegisteredScriptList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts.

<Note title="Script Registration">
  To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.scripts.list(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.scripts.<a href="src/webflow/scripts/client.py">register_hosted</a>(...) -> CustomCodeHostedResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Register a hosted script to a site.

<Note title="Script Registration">
  To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.scripts.register_hosted(
    site_id="580e63e98c9a982ac9b8b741",
    hosted_location="hostedLocation",
    integrity_hash="integrityHash",
    version="version",
    display_name="displayName",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**hosted_location:** `str` — URI for an externally hosted script location
    
</dd>
</dl>

<dl>
<dd>

**integrity_hash:** `str` — Sub-Resource Integrity Hash
    
</dd>
</dl>

<dl>
<dd>

**version:** `str` — A Semantic Version (SemVer) string, denoting the version of the script
    
</dd>
</dl>

<dl>
<dd>

**display_name:** `str` — User-facing name for the script. Must be between 1 and 50 alphanumeric characters
    
</dd>
</dl>

<dl>
<dd>

**can_copy:** `typing.Optional[bool]` — Define whether the script can be copied on site duplication and transfer
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.scripts.<a href="src/webflow/scripts/client.py">register_inline</a>(...) -> CustomCodeInlineResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Register an inline script to a site. Inline scripts are limited to 2000 characters.

<Note title="Script Registration">
  To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.scripts.register_inline(
    site_id="580e63e98c9a982ac9b8b741",
    source_code="alert(\'hello world\');",
    version="0.0.1",
    display_name="Alert",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**source_code:** `str` — The code to be added to the site (to be hosted by Webflow).
    
</dd>
</dl>

<dl>
<dd>

**version:** `str` — A Semantic Version (SemVer) string, denoting the version of the script
    
</dd>
</dl>

<dl>
<dd>

**display_name:** `str` — User-facing name for the script. Must be between 1 and 50 alphanumeric characters
    
</dd>
</dl>

<dl>
<dd>

**integrity_hash:** `typing.Optional[str]` — Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation)
    
</dd>
</dl>

<dl>
<dd>

**can_copy:** `typing.Optional[bool]` — Define whether the script can be copied on site duplication and transfer
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Assets
<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">list</a>(...) -> Assets</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List of assets uploaded to a site

Required scope | `assets:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.list(
    site_id="580e63e98c9a982ac9b8b741",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">create</a>(...) -> AssetUpload</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

The first step in uploading an asset to a site.


This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.


Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload.


To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets).

 Required scope | `assets:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.create(
    site_id="580e63e98c9a982ac9b8b741",
    file_name="file.png",
    file_hash="3c7d87c9575702bc3b1e991f4d3c638e",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**file_name:** `str` — File name including file extension. File names must be less than 100 characters.
    
</dd>
</dl>

<dl>
<dd>

**file_hash:** `str` — MD5 hash of the file
    
</dd>
</dl>

<dl>
<dd>

**parent_folder:** `typing.Optional[str]` — ID of the Asset folder (optional)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">get</a>(...) -> Asset</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get details about an asset

Required scope | `assets:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.get(
    asset_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**asset_id:** `str` — Unique identifier for an Asset on a site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete an Asset

Required Scope: `assets: write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.delete(
    asset_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**asset_id:** `str` — Unique identifier for an Asset on a site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">update</a>(...) -> Asset</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update details of an Asset.

Required scope | `assets:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.update(
    asset_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**asset_id:** `str` — Unique identifier for an Asset on a site
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization.
    
</dd>
</dl>

<dl>
<dd>

**display_name:** `typing.Optional[str]` — A human readable name for the asset
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">list_folders</a>(...) -> AssetFolderList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List Asset Folders within a given site

Required scope | `assets:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.list_folders(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">create_folder</a>(...) -> AssetFolder</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an Asset Folder within a given site

Required scope | `assets:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.create_folder(
    site_id="580e63e98c9a982ac9b8b741",
    display_name="my asset folder",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**display_name:** `str` — A human readable name for the Asset Folder
    
</dd>
</dl>

<dl>
<dd>

**parent_folder:** `typing.Optional[str]` — An (optional) pointer to a parent Asset Folder (or null for root)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.assets.<a href="src/webflow/assets/client.py">get_folder</a>(...) -> AssetFolder</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get details about a specific Asset Folder

Required scope | `assets:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.assets.get_folder(
    asset_folder_id="6390c49774a71f0e3c1a08ee",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**asset_folder_id:** `str` — Unique identifier for an Asset Folder
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Webhooks
<details><summary><code>client.webhooks.<a href="src/webflow/webhooks/client.py">list</a>(...) -> WebhookList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all App-created Webhooks registered for a given site

Required scope | `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.webhooks.list(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.<a href="src/webflow/webhooks/client.py">create</a>(...) -> Webhook</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a new Webhook.

Limit of 75 registrations per `triggerType`, per site.

<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
Required scope | `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
import datetime

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.webhooks.create(
    site_id_="580e63e98c9a982ac9b8b741",
    id="582266e0cd48de0f0e3c6d8b",
    trigger_type="form_submission",
    url="https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f",
    workspace_id="4f4e46fd476ea8c507000001",
    site_id="562ac0395358780a1f5e6fbd",
    last_triggered=datetime.datetime.fromisoformat("2023-02-08T23:59:28+00:00"),
    created_on=datetime.datetime.fromisoformat("2022-11-08T23:59:28+00:00"),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request:** `Webhook` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.<a href="src/webflow/webhooks/client.py">get</a>(...) -> Webhook</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a specific Webhook instance

Required scope: `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.webhooks.get(
    webhook_id="580e64008c9a982ac9b8b754",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**webhook_id:** `str` — Unique identifier for a Webhook
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.<a href="src/webflow/webhooks/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove a Webhook

Required scope: `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.webhooks.delete(
    webhook_id="580e64008c9a982ac9b8b754",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**webhook_id:** `str` — Unique identifier for a Webhook
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Forms
<details><summary><code>client.forms.<a href="src/webflow/forms/client.py">list</a>(...) -> FormList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List forms for a given site.

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.forms.list(
    site_id="580e63e98c9a982ac9b8b741",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.forms.<a href="src/webflow/forms/client.py">get</a>(...) -> Form</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get information about a given form.

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.forms.get(
    form_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**form_id:** `str` — Unique identifier for a Form
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.forms.<a href="src/webflow/forms/client.py">list_submissions</a>(...) -> FormSubmissionList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List form submissions for a given form

<Note title="Forms in components">
  When a form is used in a component definition, each instance of the form is considered a unique form.

  To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint.
</Note>

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.forms.list_submissions(
    form_id="580e63e98c9a982ac9b8b741",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**form_id:** `str` — Unique identifier for a Form
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.forms.<a href="src/webflow/forms/client.py">get_submission</a>(...) -> FormSubmission</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get information about a given form submissio.

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.forms.get_submission(
    form_submission_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**form_submission_id:** `str` — Unique identifier for a Form Submission
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.forms.<a href="src/webflow/forms/client.py">delete_submission</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a form submission


Required scope | `forms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.forms.delete_submission(
    form_submission_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**form_submission_id:** `str` — Unique identifier for a Form Submission
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.forms.<a href="src/webflow/forms/client.py">update_submission</a>(...) -> FormSubmission</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update hidden fields on a form submission

Required scope | `forms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.forms.update_submission(
    form_submission_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**form_submission_id:** `str` — Unique identifier for a Form Submission
    
</dd>
</dl>

<dl>
<dd>

**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Products
<details><summary><code>client.products.<a href="src/webflow/products/client.py">list</a>(...) -> ProductAndSkUsList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve all products for a site.

Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.

Required scope | `ecommerce:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.products.list(
    site_id="580e63e98c9a982ac9b8b741",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.products.<a href="src/webflow/products/client.py">create</a>(...) -> ProductAndSkUs</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU.

To create a product with multiple SKUs:
  - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large.
  - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt)
  - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku)

Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, ProductFieldData, SkuPropertyList, SkuPropertyListEnumItem, SkuFieldData, SkuFieldDataPrice
from webflow.environment import WebflowEnvironment
from webflow.products import ProductSkuCreateProduct, ProductSkuCreateSku

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.products.create(
    site_id="580e63e98c9a982ac9b8b741",
    publish_status="staging",
    product=ProductSkuCreateProduct(
        field_data=ProductFieldData(
            name="Colorful T-shirt",
            slug="colorful-t-shirt",
            description="Our best-selling t-shirt available in multiple colors and sizes",
            sku_properties=[
                SkuPropertyList(
                    id="color",
                    name="Color",
                    enum=[
                        SkuPropertyListEnumItem(
                            id="red",
                            name="Red",
                            slug="red",
                        ),
                        SkuPropertyListEnumItem(
                            id="yellow",
                            name="Yellow",
                            slug="yellow",
                        ),
                        SkuPropertyListEnumItem(
                            id="blue",
                            name="Blue",
                            slug="blue",
                        )
                    ],
                ),
                SkuPropertyList(
                    id="size",
                    name="Size",
                    enum=[
                        SkuPropertyListEnumItem(
                            id="small",
                            name="Small",
                            slug="small",
                        ),
                        SkuPropertyListEnumItem(
                            id="medium",
                            name="Medium",
                            slug="medium",
                        ),
                        SkuPropertyListEnumItem(
                            id="large",
                            name="Large",
                            slug="large",
                        )
                    ],
                )
            ],
        ),
    ),
    sku=ProductSkuCreateSku(
        field_data=SkuFieldData(
            name="Colorful T-shirt - Red Small",
            slug="colorful-t-shirt-red-small",
            price=SkuFieldDataPrice(
                value=2499,
                unit="USD",
                currency="USD",
            ),
            main_image="https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987",
        ),
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**product:** `ProductSkuCreateProduct` 
    
</dd>
</dl>

<dl>
<dd>

**sku:** `ProductSkuCreateSku` 
    
</dd>
</dl>

<dl>
<dd>

**publish_status:** `typing.Optional[PublishStatus]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.products.<a href="src/webflow/products/client.py">get</a>(...) -> ProductAndSkUs</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a single product by its ID. All of its SKUs will also be
retrieved.

Required scope | `ecommerce:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.products.get(
    site_id="580e63e98c9a982ac9b8b741",
    product_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**product_id:** `str` — Unique identifier for a Product
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.products.<a href="src/webflow/products/client.py">update</a>(...) -> Product</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update an existing Product.

Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.products.update(
    site_id="580e63e98c9a982ac9b8b741",
    product_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**product_id:** `str` — Unique identifier for a Product
    
</dd>
</dl>

<dl>
<dd>

**publish_status:** `typing.Optional[PublishStatus]` 
    
</dd>
</dl>

<dl>
<dd>

**product:** `typing.Optional[Product]` 
    
</dd>
</dl>

<dl>
<dd>

**sku:** `typing.Optional[Sku]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.products.<a href="src/webflow/products/client.py">create_sku</a>(...) -> ProductsCreateSkuResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants)

Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice
from webflow.environment import WebflowEnvironment
import datetime

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.products.create_sku(
    site_id="580e63e98c9a982ac9b8b741",
    product_id="580e63fc8c9a982ac9b8b745",
    skus=[
        Sku(
            id="66072fb71b89448912e2681c",
            cms_locale_id="653ad57de882f528b32e810e",
            last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
            last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
            created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
            field_data=SkuFieldData(
                name="Colorful T-shirt - Default",
                slug="colorful-t-shirt-default",
                price=SkuFieldDataPrice(
                    value=2499,
                    unit="USD",
                    currency="USD",
                ),
            ),
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**product_id:** `str` — Unique identifier for a Product
    
</dd>
</dl>

<dl>
<dd>

**skus:** `typing.List[Sku]` — An array of the SKU data your are adding
    
</dd>
</dl>

<dl>
<dd>

**publish_status:** `typing.Optional[PublishStatus]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.products.<a href="src/webflow/products/client.py">update_sku</a>(...) -> Sku</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a specified SKU.

Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice
from webflow.environment import WebflowEnvironment
import datetime

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.products.update_sku(
    site_id="580e63e98c9a982ac9b8b741",
    product_id="580e63fc8c9a982ac9b8b745",
    sku_id="5e8518516e147040726cc415",
    sku=Sku(
        id="66072fb71b89448912e2681c",
        cms_locale_id="653ad57de882f528b32e810e",
        last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
        last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
        created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"),
        field_data=SkuFieldData(
            name="Colorful T-shirt - Default",
            slug="colorful-t-shirt-default",
            price=SkuFieldDataPrice(
                value=2499,
                unit="USD",
                currency="USD",
            ),
        ),
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**product_id:** `str` — Unique identifier for a Product
    
</dd>
</dl>

<dl>
<dd>

**sku_id:** `str` — Unique identifier for a SKU
    
</dd>
</dl>

<dl>
<dd>

**sku:** `Sku` 
    
</dd>
</dl>

<dl>
<dd>

**publish_status:** `typing.Optional[PublishStatus]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Orders
<details><summary><code>client.orders.<a href="src/webflow/orders/client.py">list</a>(...) -> OrderList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all orders created for a given site.

Required scope | `ecommerce:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.orders.list(
    site_id="580e63e98c9a982ac9b8b741",
    status="pending",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**status:** `typing.Optional[OrdersListRequestStatus]` — Filter the orders by status
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.orders.<a href="src/webflow/orders/client.py">get</a>(...) -> Order</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve a single product by its ID. All of its SKUs will also be
retrieved.

Required scope | `ecommerce:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.orders.get(
    site_id="580e63e98c9a982ac9b8b741",
    order_id="5e8518516e147040726cc415",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**order_id:** `str` — Unique identifier for an Order
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.orders.<a href="src/webflow/orders/client.py">update</a>(...) -> Order</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

This API lets you update the fields, `comment`, `shippingProvider`,
and/or `shippingTracking` for a given order. All three fields can be
updated simultaneously or independently.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.orders.update(
    site_id="580e63e98c9a982ac9b8b741",
    order_id="5e8518516e147040726cc415",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**order_id:** `str` — Unique identifier for an Order
    
</dd>
</dl>

<dl>
<dd>

**comment:** `typing.Optional[str]` — Arbitrary data for your records
    
</dd>
</dl>

<dl>
<dd>

**shipping_provider:** `typing.Optional[str]` — Company or method used to ship order
    
</dd>
</dl>

<dl>
<dd>

**shipping_tracking:** `typing.Optional[str]` — Tracking number for order shipment
    
</dd>
</dl>

<dl>
<dd>

**shipping_tracking_url:** `typing.Optional[str]` — URL to track order shipment
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.orders.<a href="src/webflow/orders/client.py">update_fulfill</a>(...) -> Order</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an order's status to fulfilled

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.orders.update_fulfill(
    site_id="580e63e98c9a982ac9b8b741",
    order_id="5e8518516e147040726cc415",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**order_id:** `str` — Unique identifier for an Order
    
</dd>
</dl>

<dl>
<dd>

**send_order_fulfilled_email:** `typing.Optional[bool]` — Whether or not the Order Fulfilled email should be sent
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.orders.<a href="src/webflow/orders/client.py">update_unfulfill</a>(...) -> Order</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates an order's status to unfulfilled

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.orders.update_unfulfill(
    site_id="580e63e98c9a982ac9b8b741",
    order_id="5e8518516e147040726cc415",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**order_id:** `str` — Unique identifier for an Order
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.orders.<a href="src/webflow/orders/client.py">refund</a>(...) -> Order</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

This API will reverse a Stripe charge and refund an order back to a
customer. It will also set the order's status to `refunded`.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.orders.refund(
    site_id="580e63e98c9a982ac9b8b741",
    order_id="5e8518516e147040726cc415",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**order_id:** `str` — Unique identifier for an Order
    
</dd>
</dl>

<dl>
<dd>

**reason:** `typing.Optional[OrdersRefundRequestReason]` — The reason for the refund
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Inventory
<details><summary><code>client.inventory.<a href="src/webflow/inventory/client.py">list</a>(...) -> InventoryItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List the current inventory levels for a particular SKU item.

Required scope | `ecommerce:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.inventory.list(
    sku_collection_id="6377a7c4b7a79608c34a46f7",
    sku_id="5e8518516e147040726cc415",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
    
</dd>
</dl>

<dl>
<dd>

**sku_id:** `str` — Unique identifier for a SKU
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.inventory.<a href="src/webflow/inventory/client.py">update</a>(...) -> InventoryItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Updates the current inventory levels for a particular SKU item.

Updates may be given in one or two methods, absolutely or incrementally.
- Absolute updates are done by setting `quantity` directly.
- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.

Required scope | `ecommerce:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.inventory.update(
    sku_collection_id="6377a7c4b7a79608c34a46f7",
    sku_id="5e8518516e147040726cc415",
    inventory_type="infinite",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
    
</dd>
</dl>

<dl>
<dd>

**sku_id:** `str` — Unique identifier for a SKU
    
</dd>
</dl>

<dl>
<dd>

**inventory_type:** `InventoryUpdateRequestInventoryType` — infinite or finite
    
</dd>
</dl>

<dl>
<dd>

**update_quantity:** `typing.Optional[float]` — Adds this quantity to currently store quantity. Can be negative.
    
</dd>
</dl>

<dl>
<dd>

**quantity:** `typing.Optional[float]` — Immediately sets quantity to this value.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Ecommerce
<details><summary><code>client.ecommerce.<a href="src/webflow/ecommerce/client.py">get_settings</a>(...) -> EcommerceSettings</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve ecommerce settings for a site.

Required scope | `ecommerce:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.ecommerce.get_settings(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Collections Fields
<details><summary><code>client.collections.fields.<a href="src/webflow/collections/fields/client.py">create</a>(...) -> FieldCreate</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create a custom field in a collection.

Field validation is currently not available through the API.

Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create)

Required scope | `cms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, StaticField
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.fields.create(
    collection_id="580e63fc8c9a982ac9b8b745",
    request=StaticField(
        id="562ac0395358780a1f5e6fbc",
        is_editable=True,
        is_required=False,
        type="RichText",
        display_name="Post Body",
        help_text="Add the body of your post here",
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**request:** `FieldCreate` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.fields.<a href="src/webflow/collections/fields/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a custom field in a collection. This endpoint does not currently support bulk deletion.

Required scope | `cms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.fields.delete(
    collection_id="580e63fc8c9a982ac9b8b745",
    field_id="580e63fc8c9a982ac9b8b745",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**field_id:** `str` — Unique identifier for a Field in a collection
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.fields.<a href="src/webflow/collections/fields/client.py">update</a>(...) -> Field</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a custom field in a collection.

Required scope | `cms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.fields.update(
    collection_id="580e63fc8c9a982ac9b8b745",
    field_id="580e63fc8c9a982ac9b8b745",
    is_required=False,
    display_name="Post Body",
    help_text="Add the body of your post here",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**field_id:** `str` — Unique identifier for a Field in a collection
    
</dd>
</dl>

<dl>
<dd>

**is_required:** `typing.Optional[bool]` — Define whether a field is required in a collection
    
</dd>
</dl>

<dl>
<dd>

**display_name:** `typing.Optional[str]` — The name of a field
    
</dd>
</dl>

<dl>
<dd>

**help_text:** `typing.Optional[str]` — Additional text to help anyone filling out this field
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Collections Items
<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">list_items</a>(...) -> CollectionItemList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List of all Items within a Collection.

Required scope | `CMS:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.list_items(
    collection_id="580e63fc8c9a982ac9b8b745",
    cms_locale_id="cmsLocaleId",
    offset=1,
    limit=1,
    name="name",
    slug="slug",
    sort_by="createdOn",
    sort_order="asc",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
    
</dd>
</dl>

<dl>
<dd>

**created_on:** `typing.Optional[ItemsListItemsRequestCreatedOn]` — Filter by the creation date of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**last_published:** `typing.Optional[ItemsListItemsRequestLastPublished]` — Filter by the last published date of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**last_updated:** `typing.Optional[ItemsListItemsRequestLastUpdated]` — Filter by the last updated date of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[ItemsListItemsRequestSortBy]` — Sort results by the provided value
    
</dd>
</dl>

<dl>
<dd>

**sort_order:** `typing.Optional[ItemsListItemsRequestSortOrder]` — Sorts the results by asc or desc
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">create_item</a>(...) -> CollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create Item(s) in a Collection.


To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, CollectionItemPostSingle, CollectionItemPostSingleFieldData
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.create_item(
    collection_id="580e63fc8c9a982ac9b8b745",
    skip_invalid_files=True,
    request=CollectionItemPostSingle(
        is_archived=False,
        is_draft=False,
        field_data=CollectionItemPostSingleFieldData(
            name="The Hitchhiker\'s Guide to the Galaxy",
            slug="hitchhikers-guide-to-the-galaxy",
        ),
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**request:** `ItemsCreateItemRequestBody` 
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">delete_items</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete Items from a Collection.

<Tip title="Localization Tip">Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request.</Tip>

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
from webflow.collections.items import ItemsDeleteItemsRequestItemsItem

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.delete_items(
    collection_id="580e63fc8c9a982ac9b8b745",
    items=[
        ItemsDeleteItemsRequestItemsItem(
            id="580e64008c9a982ac9b8b754",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**items:** `typing.List[ItemsDeleteItemsRequestItemsItem]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">update_items</a>(...) -> ItemsUpdateItemsResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a single item or multiple items in a Collection.

The limit for this endpoint is 100 items.

<Tip title="Localization Tip">Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.</Tip>

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.update_items(
    collection_id="580e63fc8c9a982ac9b8b745",
    skip_invalid_files=True,
    items=[
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5ea6",
            cms_locale_id="66f6e966c9e1dc700a857ca5",
            field_data=CollectionItemWithIdInputFieldData(
                name="Ne Paniquez Pas",
                slug="ne-paniquez-pas",
            ),
        ),
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5ea6",
            cms_locale_id="66f6e966c9e1dc700a857ca4",
            field_data=CollectionItemWithIdInputFieldData(
                name="No Entrar en Pánico",
                slug="no-entrar-en-panico",
            ),
        ),
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5eaa",
            cms_locale_id="66f6e966c9e1dc700a857ca5",
            field_data=CollectionItemWithIdInputFieldData(
                name="Au Revoir et Merci pour Tous les Poissons",
                slug="au-revoir-et-merci",
            ),
        ),
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5eaa",
            cms_locale_id="66f6e966c9e1dc700a857ca4",
            field_data=CollectionItemWithIdInputFieldData(
                name="Hasta Luego y Gracias por Todo el Pescado",
                slug="hasta-luego-y-gracias",
            ),
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">list_items_live</a>(...) -> CollectionItemList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all published items in a collection.

<Tip title="Serve data with the Content Delivery API">
  Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
</Tip>

Required scope | `CMS:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.list_items_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    cms_locale_id="cmsLocaleId",
    offset=1,
    limit=1,
    name="name",
    slug="slug",
    sort_by="createdOn",
    sort_order="asc",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
    
</dd>
</dl>

<dl>
<dd>

**created_on:** `typing.Optional[ItemsListItemsLiveRequestCreatedOn]` — Filter by the creation date of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**last_published:** `typing.Optional[ItemsListItemsLiveRequestLastPublished]` — Filter by the last published date of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**last_updated:** `typing.Optional[ItemsListItemsLiveRequestLastUpdated]` — Filter by the last updated date of the item(s)
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[ItemsListItemsLiveRequestSortBy]` — Sort results by the provided value
    
</dd>
</dl>

<dl>
<dd>

**sort_order:** `typing.Optional[ItemsListItemsLiveRequestSortOrder]` — Sorts the results by asc or desc
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">create_item_live</a>(...) -> CollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create item(s) in a collection that will be immediately published to the live site.


To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items)


Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, CollectionItem, CollectionItemFieldData
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.create_item_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    skip_invalid_files=True,
    request=CollectionItem(
        is_archived=False,
        is_draft=False,
        field_data=CollectionItemFieldData(
            name="The Hitchhiker\'s Guide to the Galaxy",
            slug="hitchhikers-guide-to-the-galaxy",
        ),
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**request:** `ItemsCreateItemLiveRequestBody` 
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">delete_items_live</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Unpublish up to 100 items from the live site and set the `isDraft` property to `true`.

<Tip title="Localization Tip">Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.</Tip>

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
from webflow.collections.items import ItemsDeleteItemsLiveRequestItemsItem

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.delete_items_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    items=[
        ItemsDeleteItemsLiveRequestItemsItem(
            id="580e64008c9a982ac9b8b754",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**items:** `typing.List[ItemsDeleteItemsLiveRequestItemsItem]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">update_items_live</a>(...) -> CollectionItemListNoPagination</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a single published item or multiple published items (up to 100) in a Collection

<Tip title="Localization Tip">Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.</Tip>

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.update_items_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    skip_invalid_files=True,
    items=[
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5ea6",
            cms_locale_id="66f6e966c9e1dc700a857ca5",
            field_data=CollectionItemWithIdInputFieldData(
                name="Ne Paniquez Pas",
                slug="ne-paniquez-pas",
            ),
        ),
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5ea6",
            cms_locale_id="66f6e966c9e1dc700a857ca4",
            field_data=CollectionItemWithIdInputFieldData(
                name="No Entrar en Pánico",
                slug="no-entrar-en-panico",
            ),
        ),
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5eaa",
            cms_locale_id="66f6e966c9e1dc700a857ca5",
            field_data=CollectionItemWithIdInputFieldData(
                name="Au Revoir et Merci pour Tous les Poissons",
                slug="au-revoir-et-merci",
            ),
        ),
        CollectionItemWithIdInput(
            id="66f6ed9576ddacf3149d5eaa",
            cms_locale_id="66f6e966c9e1dc700a857ca4",
            field_data=CollectionItemWithIdInputFieldData(
                name="Hasta Luego y Gracias por Todo el Pescado",
                slug="hasta-luego-y-gracias",
            ),
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">create_items</a>(...) -> BulkCollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Create an item or multiple items in a CMS Collection across multiple corresponding locales.

<Note>
  - This endpoint can create up to 100 items in a request.
  - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
</Note>

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
from webflow.collections.items import SingleCmsItem

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.create_items(
    collection_id="580e63fc8c9a982ac9b8b745",
    skip_invalid_files=True,
    cms_locale_ids=[
        "66f6e966c9e1dc700a857ca3",
        "66f6e966c9e1dc700a857ca4",
        "66f6e966c9e1dc700a857ca5"
    ],
    is_archived=False,
    is_draft=False,
    field_data=SingleCmsItem(
        name="Don’t Panic",
        slug="dont-panic",
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**field_data:** `CreateBulkCollectionItemRequestBodyFieldData` 
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_ids:** `typing.Optional[typing.List[str]]` — Array of identifiers for the locales where the item will be created
    
</dd>
</dl>

<dl>
<dd>

**is_archived:** `typing.Optional[bool]` — Indicates whether the item is archived.
    
</dd>
</dl>

<dl>
<dd>

**is_draft:** `typing.Optional[bool]` — Indicates whether the item is in draft state.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">get_item</a>(...) -> CollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get details of a selected Collection Item.

Required scope | `CMS:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.get_item(
    collection_id="580e63fc8c9a982ac9b8b745",
    item_id="580e64008c9a982ac9b8b754",
    cms_locale_id="cmsLocaleId",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**item_id:** `str` — Unique identifier for an Item
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">delete_item</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete an item from a collection.

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.delete_item(
    collection_id="580e63fc8c9a982ac9b8b745",
    item_id="580e64008c9a982ac9b8b754",
    cms_locale_id="cmsLocaleId",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**item_id:** `str` — Unique identifier for an Item
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">update_item</a>(...) -> CollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a selected Item in a Collection.

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, CollectionItemPatchSingleFieldData
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.update_item(
    collection_id="580e63fc8c9a982ac9b8b745",
    item_id="580e64008c9a982ac9b8b754",
    skip_invalid_files=True,
    is_archived=False,
    is_draft=False,
    field_data=CollectionItemPatchSingleFieldData(
        name="The Hitchhiker\'s Guide to the Galaxy",
        slug="hitchhikers-guide-to-the-galaxy",
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**item_id:** `str` — Unique identifier for an Item
    
</dd>
</dl>

<dl>
<dd>

**request:** `CollectionItemPatchSingle` 
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">get_item_live</a>(...) -> CollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get details of a selected Collection live Item.

<Tip title="Serve data with the Content Delivery API">
  Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations.
</Tip>

Required scope | `CMS:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.get_item_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    item_id="580e64008c9a982ac9b8b754",
    cms_locale_id="cmsLocaleId",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**item_id:** `str` — Unique identifier for an Item
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">delete_item_live</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Unpublish a live item from the site and set the `isDraft` property to `true`.

For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live)

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.delete_item_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    item_id="580e64008c9a982ac9b8b754",
    cms_locale_id="cmsLocaleId",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**item_id:** `str` — Unique identifier for an Item
    
</dd>
</dl>

<dl>
<dd>

**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">update_item_live</a>(...) -> CollectionItem</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a selected live Item in a Collection. The updates for this Item will be published to the live site.

Required scope | `CMS:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, CollectionItemPatchSingleFieldData
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.update_item_live(
    collection_id="580e63fc8c9a982ac9b8b745",
    item_id="580e64008c9a982ac9b8b754",
    skip_invalid_files=True,
    is_archived=False,
    is_draft=False,
    field_data=CollectionItemPatchSingleFieldData(
        name="The Hitchhiker\'s Guide to the Galaxy",
        slug="hitchhikers-guide-to-the-galaxy",
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**item_id:** `str` — Unique identifier for an Item
    
</dd>
</dl>

<dl>
<dd>

**request:** `CollectionItemPatchSingle` 
    
</dd>
</dl>

<dl>
<dd>

**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.collections.items.<a href="src/webflow/collections/items/client.py">publish_item</a>(...) -> ItemsPublishItemResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Publish an item or multiple items.

Required scope | `cms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
from webflow.collections.items import ItemIDs

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.collections.items.publish_item(
    collection_id="580e63fc8c9a982ac9b8b745",
    request=ItemIDs(
        item_ids=[
            "643fd856d66b6528195ee2ca",
            "643fd856d66b6528195ee2cb",
            "643fd856d66b6528195ee2cc"
        ],
    ),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**collection_id:** `str` — Unique identifier for a Collection
    
</dd>
</dl>

<dl>
<dd>

**request:** `ItemsPublishItemRequest` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Pages Scripts
<details><summary><code>client.pages.scripts.<a href="src/webflow/pages/scripts/client.py">get_custom_code</a>(...) -> ScriptApplyList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get all scripts applied to a page.

Required scope | `custom_code:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.scripts.get_custom_code(
    page_id="63c720f9347c2139b248e552",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pages.scripts.<a href="src/webflow/pages/scripts/client.py">upsert_custom_code</a>(...) -> ScriptApplyList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.

<Note title="Script Registration">
  To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, ScriptApply
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.scripts.upsert_custom_code(
    page_id="63c720f9347c2139b248e552",
    scripts=[
        ScriptApply(
            id="cms_slider",
            location="header",
            version="1.0.0",
            attributes={
                "my-attribute": "some-value"
            },
        ),
        ScriptApply(
            id="alert",
            location="header",
            version="0.0.1",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**request:** `ScriptApplyList` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.pages.scripts.<a href="src/webflow/pages/scripts/client.py">delete_custom_code</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts.

To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint.

<Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>

Required scope | `custom_code:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.pages.scripts.delete_custom_code(
    page_id="63c720f9347c2139b248e552",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**page_id:** `str` — Unique identifier for a Page
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites Redirects
<details><summary><code>client.sites.redirects.<a href="src/webflow/sites/redirects/client.py">list</a>(...) -> Redirects</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Fetch a list of all 301 redirect rules configured for a specific site.

Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.redirects.list(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.redirects.<a href="src/webflow/sites/redirects/client.py">create</a>(...) -> Redirect</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Add a new 301 redirection rule to a site.

This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.redirects.create(
    site_id="580e63e98c9a982ac9b8b741",
    id="42e1a2b7aa1a13f768a0042a",
    from_url="/mostly-harmless",
    to_url="/earth",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request:** `Redirect` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.redirects.<a href="src/webflow/sites/redirects/client.py">delete</a>(...) -> Redirects</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove a 301 redirection rule from a site.

This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.redirects.delete(
    site_id="580e63e98c9a982ac9b8b741",
    redirect_id="66c4cb9a20cac35ed19500e6",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**redirect_id:** `str` — Unique identifier site redirect
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.redirects.<a href="src/webflow/sites/redirects/client.py">update</a>(...) -> Redirect</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update a 301 redirection rule from a site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `sites:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.redirects.update(
    site_id="580e63e98c9a982ac9b8b741",
    redirect_id="66c4cb9a20cac35ed19500e6",
    id="42e1a2b7aa1a13f768a0042a",
    from_url="/mostly-harmless",
    to_url="/earth",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**redirect_id:** `str` — Unique identifier site redirect
    
</dd>
</dl>

<dl>
<dd>

**request:** `Redirect` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites Plans
<details><summary><code>client.sites.plans.<a href="src/webflow/sites/plans/client.py">get_site_plan</a>(...) -> SitePlan</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get site plan details for the specified Site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope | `sites:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.plans.get_site_plan(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites RobotsTxt
<details><summary><code>client.sites.robots_txt.<a href="src/webflow/sites/robots_txt/client.py">get</a>(...) -> Robots</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve the robots.txt configuration for various user agents.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `site_config:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.robots_txt.get(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.robots_txt.<a href="src/webflow/sites/robots_txt/client.py">put</a>(...) -> Robots</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Replace the `robots.txt` configuration for various user agents.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope | `site_config:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, RobotsRulesItem
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.robots_txt.put(
    site_id="580e63e98c9a982ac9b8b741",
    rules=[
        RobotsRulesItem(
            user_agent="googlebot",
            allows=[
                "/public"
            ],
            disallows=[
                "/vogon-poetry",
                "/total-perspective-vortex"
            ],
        )
    ],
    sitemap="https://heartofgold.ship/sitemap.xml",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request:** `Robots` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.robots_txt.<a href="src/webflow/sites/robots_txt/client.py">delete</a>(...) -> Robots</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior.

**Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `site_config:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, RobotsRulesItem
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.robots_txt.delete(
    site_id="580e63e98c9a982ac9b8b741",
    rules=[
        RobotsRulesItem(
            user_agent="*",
            allows=[
                "/public"
            ],
            disallows=[
                "/bubbles"
            ],
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request:** `Robots` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.robots_txt.<a href="src/webflow/sites/robots_txt/client.py">patch</a>(...) -> Robots</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update the `robots.txt` configuration for various user agents.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope | `site_config:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, RobotsRulesItem
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.robots_txt.patch(
    site_id="580e63e98c9a982ac9b8b741",
    rules=[
        RobotsRulesItem(
            user_agent="googlebot",
            allows=[
                "/public"
            ],
            disallows=[
                "/vogon-poetry",
                "/total-perspective-vortex"
            ],
        )
    ],
    sitemap="https://heartofgold.ship/sitemap.xml",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request:** `Robots` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites WellKnown
<details><summary><code>client.sites.well_known.<a href="src/webflow/sites/well_known/client.py">put</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Upload a supported well-known file to a site.

The current restrictions on well-known files are as follows:
  - Each file must be smaller than 100kb
  - Less than 30 total files
  - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`

  <Note title=".noext">
    `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
  </Note>

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `site_config:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.well_known.put(
    site_id="580e63e98c9a982ac9b8b741",
    file_name="apple-app-site-association.txt",
    file_data="{\n  \"applinks\": {\n    \"apps\": [],\n    \"details\": [\n  {\n    \"appID\": \"ABCDE12345.com.example.app\",\n    \"paths\": [ \"/*\", \"/some/path/*\" ]\n      }\n    ]\n  }\n}\n",
    content_type="application/json",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**file_name:** `str` — The name of the file
    
</dd>
</dl>

<dl>
<dd>

**file_data:** `str` — The contents of the file
    
</dd>
</dl>

<dl>
<dd>

**content_type:** `typing.Optional[WellKnownFileContentType]` — The content type of the file. Defaults to application/json
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.well_known.<a href="src/webflow/sites/well_known/client.py">delete</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete existing well-known files from a site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `site_config:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.well_known.delete(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**file_names:** `typing.Optional[typing.List[str]]` — A list of file names to delete
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites ActivityLogs
<details><summary><code>client.sites.activity_logs.<a href="src/webflow/sites/activity_logs/client.py">list</a>(...) -> SiteActivityLogResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Retrieve Activity Logs for a specific Site.

<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>

Required scope: `site_activity:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.activity_logs.list(
    site_id="580e63e98c9a982ac9b8b741",
    limit=1,
    offset=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites Comments
<details><summary><code>client.sites.comments.<a href="src/webflow/sites/comments/client.py">list_comment_threads</a>(...) -> CommentThreadList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all comment threads for a site.

<Note title="Timing of comment threads">
  There may be a delay of up to 5 minutes before new comments appear in the system.
</Note>

Required scope | `comments:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.comments.list_comment_threads(
    site_id="580e63e98c9a982ac9b8b741",
    locale_id="65427cf400e02b306eaa04a0",
    offset=1,
    limit=1,
    sort_by="createdOn",
    sort_order="asc",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[CommentsListCommentThreadsRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
    
</dd>
</dl>

<dl>
<dd>

**sort_order:** `typing.Optional[CommentsListCommentThreadsRequestSortOrder]` — Sorts the results by asc or desc
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.comments.<a href="src/webflow/sites/comments/client.py">get_comment_thread</a>(...) -> CommentThread</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get details of a specific comment thread.

  <Note title="Timing of comment threads">
    There may be a delay of up to 5 minutes before new comments appear in the system.
  </Note>

Required scope | `comments:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.comments.get_comment_thread(
    site_id="580e63e98c9a982ac9b8b741",
    comment_thread_id="580e63e98c9a982ac9b8b741",
    locale_id="65427cf400e02b306eaa04a0",
    offset=1,
    limit=1,
    sort_by="createdOn",
    sort_order="asc",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**comment_thread_id:** `str` — Unique identifier for a Comment Thread
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[CommentsGetCommentThreadRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
    
</dd>
</dl>

<dl>
<dd>

**sort_order:** `typing.Optional[CommentsGetCommentThreadRequestSortOrder]` — Sorts the results by asc or desc
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.comments.<a href="src/webflow/sites/comments/client.py">list_comment_replies</a>(...) -> CommentReplyList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all replies to a specific comment thread.

<Note title="Timing of comment threads">
  There may be a delay of up to 5 minutes before new comments appear in the system.
</Note>

Required scope | `comments:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.comments.list_comment_replies(
    site_id="580e63e98c9a982ac9b8b741",
    comment_thread_id="580e63e98c9a982ac9b8b741",
    locale_id="65427cf400e02b306eaa04a0",
    offset=1,
    limit=1,
    sort_by="createdOn",
    sort_order="asc",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**comment_thread_id:** `str` — Unique identifier for a Comment Thread
    
</dd>
</dl>

<dl>
<dd>

**locale_id:** `typing.Optional[str]` 

Unique identifier for a specific Locale.

[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**sort_by:** `typing.Optional[CommentsListCommentRepliesRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
    
</dd>
</dl>

<dl>
<dd>

**sort_order:** `typing.Optional[CommentsListCommentRepliesRequestSortOrder]` — Sorts the results by asc or desc
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites Scripts
<details><summary><code>client.sites.scripts.<a href="src/webflow/sites/scripts/client.py">get_custom_code</a>(...) -> ScriptApplyList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get all scripts applied to a site by the App.

<Note title="Script Registration">
  To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.scripts.get_custom_code(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.scripts.<a href="src/webflow/sites/scripts/client.py">upsert_custom_code</a>(...) -> ScriptApplyList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body.

<Note title="Script Registration">
  To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow, ScriptApply
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.scripts.upsert_custom_code(
    site_id="580e63e98c9a982ac9b8b741",
    scripts=[
        ScriptApply(
            id="cms_slider",
            location="header",
            version="1.0.0",
            attributes={
                "my-attribute": "some-value"
            },
        ),
        ScriptApply(
            id="alert",
            location="header",
            version="0.0.1",
        )
    ],
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request:** `ScriptApplyList` 
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.scripts.<a href="src/webflow/sites/scripts/client.py">delete_custom_code</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.

To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint.

<Note>Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app).</Note>

Required scope | `custom_code:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.scripts.delete_custom_code(
    site_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.scripts.<a href="src/webflow/sites/scripts/client.py">list_custom_code_blocks</a>(...) -> ListCustomCodeBlocks</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get a list of scripts that have been applied to a site and/or individual pages.

<Note title="Script Registration">
  To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.

  See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Required scope | `custom_code:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.scripts.list_custom_code_blocks(
    site_id="580e63e98c9a982ac9b8b741",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Sites Forms
<details><summary><code>client.sites.forms.<a href="src/webflow/sites/forms/client.py">list_submissions_by_site</a>(...) -> FormSubmissionList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`.

Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response).

<Note title="Forms in components">
When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components.
</Note>

Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID.

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.forms.list_submissions_by_site(
    site_id="580e63e98c9a982ac9b8b741",
    element_id="18259716-3e5a-646a-5f41-5dc4b9405aa0",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**element_id:** `typing.Optional[str]` — Identifier for an element
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.forms.<a href="src/webflow/sites/forms/client.py">list_submissions</a>(...) -> FormSubmissionList</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

List form submissions for a given form ID within a specific site.

Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`.

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.forms.list_submissions(
    site_id="580e63e98c9a982ac9b8b741",
    form_id="580e63e98c9a982ac9b8b741",
    offset=1,
    limit=1,
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**form_id:** `str` — Unique identifier for a Form
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.forms.<a href="src/webflow/sites/forms/client.py">get_submission</a>(...) -> FormSubmission</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get information about a form submission within a specific site.

Required scope | `forms:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.forms.get_submission(
    site_id="580e63e98c9a982ac9b8b741",
    form_submission_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**form_submission_id:** `str` — Unique identifier for a Form Submission
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.forms.<a href="src/webflow/sites/forms/client.py">delete_submission</a>(...)</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Delete a form submission within a specific site.

Required scope | `forms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.forms.delete_submission(
    site_id="580e63e98c9a982ac9b8b741",
    form_submission_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**form_submission_id:** `str` — Unique identifier for a Form Submission
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.sites.forms.<a href="src/webflow/sites/forms/client.py">update_submission</a>(...) -> FormSubmission</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Update hidden fields on a form submission within a specific site.

Required scope | `forms:write`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.sites.forms.update_submission(
    site_id="580e63e98c9a982ac9b8b741",
    form_submission_id="580e63e98c9a982ac9b8b741",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**site_id:** `str` — Unique identifier for a Site
    
</dd>
</dl>

<dl>
<dd>

**form_submission_id:** `str` — Unique identifier for a Form Submission
    
</dd>
</dl>

<dl>
<dd>

**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## Workspaces AuditLogs
<details><summary><code>client.workspaces.audit_logs.<a href="src/webflow/workspaces/audit_logs/client.py">get_workspace_audit_logs</a>(...) -> WorkspaceAuditLogResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Get audit logs for a workspace.

<Warning title="Enterprise & workspace API token only">This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint.</Warning>

Required scope | `workspace_activity:read`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from webflow import Webflow
from webflow.environment import WebflowEnvironment
import datetime

client = Webflow(
    access_token="<token>",
    environment=WebflowEnvironment.DATA_API,
)

client.workspaces.audit_logs.get_workspace_audit_logs(
    workspace_id_or_slug="hitchhikers-workspace",
    limit=1,
    offset=1,
    sort_order="asc",
    event_type="user_access",
    from_=datetime.datetime.fromisoformat("2025-06-22T16:00:31+00:00"),
    to=datetime.datetime.fromisoformat("2025-07-22T16:00:31+00:00"),
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**workspace_id_or_slug:** `str` — Unique identifier or slug for a Workspace
    
</dd>
</dl>

<dl>
<dd>

**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
    
</dd>
</dl>

<dl>
<dd>

**sort_order:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder]` — Sorts the results by asc or desc
    
</dd>
</dl>

<dl>
<dd>

**event_type:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType]` — The event type to filter by
    
</dd>
</dl>

<dl>
<dd>

**from:** `typing.Optional[datetime.datetime]` — The start date to filter by
    
</dd>
</dl>

<dl>
<dd>

**to:** `typing.Optional[datetime.datetime]` — The end date to filter by
    
</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>