webflow-api 3.1.0 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/__package__.yml +363 -79
- package/.mock/definition/accessGroups.yml +1 -0
- package/.mock/definition/assets.yml +86 -47
- package/.mock/definition/collections/fields.yml +63 -46
- package/.mock/definition/collections/items.yml +58 -30
- package/.mock/definition/collections.yml +42 -7
- package/.mock/definition/components.yml +43 -50
- package/.mock/definition/ecommerce.yml +1 -0
- package/.mock/definition/forms.yml +114 -2
- package/.mock/definition/inventory.yml +2 -0
- package/.mock/definition/orders.yml +6 -68
- package/.mock/definition/pages/scripts.yml +10 -44
- package/.mock/definition/pages.yml +36 -41
- package/.mock/definition/products.yml +9 -0
- package/.mock/definition/scripts.yml +18 -49
- package/.mock/definition/sites/activityLogs.yml +10 -7
- package/.mock/definition/sites/plans.yml +7 -1
- package/.mock/definition/sites/redirects.yml +24 -1
- package/.mock/definition/sites/robotsTxt.yml +202 -0
- package/.mock/definition/sites/scripts.yml +22 -30
- package/.mock/definition/sites.yml +27 -30
- package/.mock/definition/token.yml +2 -0
- package/.mock/definition/users.yml +4 -0
- package/.mock/definition/webhooks.yml +7 -8
- package/.mock/fern.config.json +1 -1
- package/api/resources/accessGroups/client/Client.js +1 -1
- package/api/resources/assets/client/Client.d.ts +10 -7
- package/api/resources/assets/client/Client.js +18 -15
- package/api/resources/collections/client/Client.d.ts +21 -1
- package/api/resources/collections/client/Client.js +27 -5
- package/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts +23 -1
- package/api/resources/collections/resources/fields/client/Client.d.ts +34 -4
- package/api/resources/collections/resources/fields/client/Client.js +40 -8
- package/api/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/api/resources/collections/resources/fields/index.d.ts +0 -1
- package/api/resources/collections/resources/fields/index.js +0 -1
- package/api/resources/collections/resources/index.d.ts +1 -2
- package/api/resources/collections/resources/index.js +2 -3
- package/api/resources/collections/resources/items/client/Client.d.ts +19 -12
- package/api/resources/collections/resources/items/client/Client.js +39 -28
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/api/resources/components/client/Client.d.ts +5 -6
- package/api/resources/components/client/Client.js +10 -11
- package/api/resources/ecommerce/client/Client.js +1 -1
- package/api/resources/forms/client/Client.d.ts +51 -0
- package/api/resources/forms/client/Client.js +226 -5
- package/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +23 -0
- package/api/resources/forms/client/requests/index.d.ts +1 -0
- package/api/resources/inventory/client/Client.js +2 -2
- package/api/resources/orders/client/Client.js +6 -6
- package/api/resources/pages/client/Client.d.ts +8 -3
- package/api/resources/pages/client/Client.js +13 -8
- package/api/resources/pages/resources/scripts/client/Client.d.ts +6 -20
- package/api/resources/pages/resources/scripts/client/Client.js +9 -23
- package/api/resources/products/client/Client.js +6 -6
- package/api/resources/scripts/client/Client.d.ts +12 -20
- package/api/resources/scripts/client/Client.js +15 -23
- package/api/resources/sites/client/Client.d.ts +12 -3
- package/api/resources/sites/client/Client.js +25 -14
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +5 -1
- package/api/resources/sites/resources/activityLogs/client/Client.js +6 -2
- package/api/resources/sites/resources/index.d.ts +1 -0
- package/api/resources/sites/resources/index.js +2 -1
- package/api/resources/sites/resources/plans/client/Client.d.ts +2 -0
- package/api/resources/sites/resources/plans/client/Client.js +3 -1
- package/api/resources/sites/resources/redirects/client/Client.d.ts +10 -0
- package/api/resources/sites/resources/redirects/client/Client.js +14 -4
- package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +124 -0
- package/api/resources/sites/resources/robotsTxt/client/Client.js +486 -0
- package/api/resources/sites/resources/robotsTxt/client/index.d.ts +1 -0
- package/api/resources/sites/resources/robotsTxt/client/index.js +2 -0
- package/api/resources/sites/resources/robotsTxt/index.d.ts +1 -0
- package/api/resources/{collections/resources/fields/types → sites/resources/robotsTxt}/index.js +1 -1
- package/api/resources/sites/resources/scripts/client/Client.d.ts +15 -13
- package/api/resources/sites/resources/scripts/client/Client.js +19 -17
- package/api/resources/token/client/Client.js +2 -2
- package/api/resources/users/client/Client.js +5 -5
- package/api/resources/users/client/requests/UsersInviteRequest.d.ts +1 -4
- package/api/resources/users/client/requests/UsersUpdateRequest.d.ts +1 -4
- package/api/resources/webhooks/client/Client.js +4 -4
- package/api/types/Asset.d.ts +4 -0
- package/api/types/AssetVariant.d.ts +3 -0
- package/api/types/Assets.d.ts +1 -0
- package/api/types/ComponentNode.d.ts +2 -2
- package/api/types/Conflict.d.ts +4 -0
- package/api/types/Dom.d.ts +2 -0
- package/api/types/FieldCreate.d.ts +8 -0
- package/api/types/FieldCreate.js +5 -0
- package/api/types/FieldType.d.ts +3 -1
- package/api/types/FieldType.js +2 -0
- package/api/types/ImageNode.d.ts +1 -0
- package/api/types/ImageNodeImage.d.ts +3 -0
- package/api/types/Metadata.d.ts +11 -0
- package/api/types/Metadata.js +5 -0
- package/api/types/MetadataOptionsItem.d.ts +12 -0
- package/api/types/MetadataOptionsItem.js +5 -0
- package/api/types/OAuthScope.d.ts +8 -0
- package/api/types/OAuthScope.js +2 -0
- package/api/types/OptionField.d.ts +19 -0
- package/api/types/OptionField.js +5 -0
- package/api/types/ReferenceField.d.ts +20 -0
- package/api/types/ReferenceField.js +5 -0
- package/api/types/ReferenceFieldMetadata.d.ts +10 -0
- package/api/types/ReferenceFieldMetadata.js +5 -0
- package/api/types/ReferenceFieldType.d.ts +11 -0
- package/api/types/ReferenceFieldType.js +10 -0
- package/api/types/Robots.d.ts +13 -0
- package/api/types/Robots.js +5 -0
- package/api/types/RobotsRulesItem.d.ts +11 -0
- package/api/types/RobotsRulesItem.js +5 -0
- package/api/types/SkuFieldData.d.ts +2 -0
- package/api/types/SkuFieldDataEcSkuBillingMethod.d.ts +3 -0
- package/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +3 -0
- package/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts} +7 -12
- package/api/types/StaticField.js +5 -0
- package/api/{resources/collections/resources/fields/types/FieldCreateType.d.ts → types/StaticFieldType.d.ts} +2 -3
- package/{dist/api/resources/collections/resources/fields/types/FieldCreateType.js → api/types/StaticFieldType.js} +2 -3
- package/api/types/Text.d.ts +3 -0
- package/api/types/TextNode.d.ts +1 -0
- package/api/types/TextNodeText.d.ts +3 -0
- package/api/types/TriggerType.d.ts +1 -15
- package/api/types/WebhookList.d.ts +1 -1
- package/api/types/index.d.ts +12 -0
- package/api/types/index.js +12 -0
- package/dist/api/resources/accessGroups/client/Client.js +1 -1
- package/dist/api/resources/assets/client/Client.d.ts +10 -7
- package/dist/api/resources/assets/client/Client.js +18 -15
- package/dist/api/resources/collections/client/Client.d.ts +21 -1
- package/dist/api/resources/collections/client/Client.js +27 -5
- package/dist/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts +23 -1
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -4
- package/dist/api/resources/collections/resources/fields/client/Client.js +40 -8
- package/dist/api/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/index.js +0 -1
- package/dist/api/resources/collections/resources/index.d.ts +1 -2
- package/dist/api/resources/collections/resources/index.js +2 -3
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +19 -12
- package/dist/api/resources/collections/resources/items/client/Client.js +39 -28
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/dist/api/resources/components/client/Client.d.ts +5 -6
- package/dist/api/resources/components/client/Client.js +10 -11
- package/dist/api/resources/ecommerce/client/Client.js +1 -1
- package/dist/api/resources/forms/client/Client.d.ts +51 -0
- package/dist/api/resources/forms/client/Client.js +226 -5
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +23 -0
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +5 -0
- package/dist/api/resources/forms/client/requests/index.d.ts +1 -0
- package/dist/api/resources/inventory/client/Client.js +2 -2
- package/dist/api/resources/orders/client/Client.js +6 -6
- package/dist/api/resources/pages/client/Client.d.ts +8 -3
- package/dist/api/resources/pages/client/Client.js +13 -8
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +6 -20
- package/dist/api/resources/pages/resources/scripts/client/Client.js +9 -23
- package/dist/api/resources/products/client/Client.js +6 -6
- package/dist/api/resources/scripts/client/Client.d.ts +12 -20
- package/dist/api/resources/scripts/client/Client.js +15 -23
- package/dist/api/resources/sites/client/Client.d.ts +12 -3
- package/dist/api/resources/sites/client/Client.js +25 -14
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +5 -1
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +6 -2
- package/dist/api/resources/sites/resources/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/index.js +2 -1
- package/dist/api/resources/sites/resources/plans/client/Client.d.ts +2 -0
- package/dist/api/resources/sites/resources/plans/client/Client.js +3 -1
- package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +10 -0
- package/dist/api/resources/sites/resources/redirects/client/Client.js +14 -4
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +124 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +486 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/index.js +2 -0
- package/dist/api/resources/sites/resources/robotsTxt/index.d.ts +1 -0
- package/dist/{serialization/resources/collections/resources/fields/types → api/resources/sites/resources/robotsTxt}/index.js +1 -1
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +15 -13
- package/dist/api/resources/sites/resources/scripts/client/Client.js +19 -17
- package/dist/api/resources/token/client/Client.js +2 -2
- package/dist/api/resources/users/client/Client.js +5 -5
- package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +1 -4
- package/dist/api/resources/users/client/requests/UsersUpdateRequest.d.ts +1 -4
- package/dist/api/resources/webhooks/client/Client.js +4 -4
- package/dist/api/types/Asset.d.ts +4 -0
- package/dist/api/types/AssetVariant.d.ts +3 -0
- package/dist/api/types/Assets.d.ts +1 -0
- package/dist/api/types/ComponentNode.d.ts +2 -2
- package/dist/api/types/Conflict.d.ts +4 -0
- package/dist/api/types/Conflict.js +5 -0
- package/dist/api/types/Dom.d.ts +2 -0
- package/dist/api/types/FieldCreate.d.ts +8 -0
- package/dist/api/types/FieldCreate.js +5 -0
- package/dist/api/types/FieldType.d.ts +3 -1
- package/dist/api/types/FieldType.js +2 -0
- package/dist/api/types/ImageNode.d.ts +1 -0
- package/dist/api/types/ImageNodeImage.d.ts +3 -0
- package/dist/api/types/Metadata.d.ts +11 -0
- package/dist/api/types/Metadata.js +5 -0
- package/dist/api/types/MetadataOptionsItem.d.ts +12 -0
- package/dist/api/types/MetadataOptionsItem.js +5 -0
- package/dist/api/types/OAuthScope.d.ts +8 -0
- package/dist/api/types/OAuthScope.js +2 -0
- package/dist/api/types/OptionField.d.ts +19 -0
- package/dist/api/types/OptionField.js +5 -0
- package/dist/api/types/ReferenceField.d.ts +20 -0
- package/dist/api/types/ReferenceField.js +5 -0
- package/dist/api/types/ReferenceFieldMetadata.d.ts +10 -0
- package/dist/api/types/ReferenceFieldMetadata.js +5 -0
- package/dist/api/types/ReferenceFieldType.d.ts +11 -0
- package/dist/api/types/ReferenceFieldType.js +10 -0
- package/dist/api/types/Robots.d.ts +13 -0
- package/dist/api/types/Robots.js +5 -0
- package/dist/api/types/RobotsRulesItem.d.ts +11 -0
- package/dist/api/types/RobotsRulesItem.js +5 -0
- package/dist/api/types/SkuFieldData.d.ts +2 -0
- package/dist/api/types/SkuFieldDataEcSkuBillingMethod.d.ts +3 -0
- package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +3 -0
- package/dist/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts} +7 -12
- package/dist/api/types/StaticField.js +5 -0
- package/dist/api/{resources/collections/resources/fields/types/FieldCreateType.d.ts → types/StaticFieldType.d.ts} +2 -3
- package/{api/resources/collections/resources/fields/types/FieldCreateType.js → dist/api/types/StaticFieldType.js} +2 -3
- package/dist/api/types/Text.d.ts +3 -0
- package/dist/api/types/TextNode.d.ts +1 -0
- package/dist/api/types/TextNodeText.d.ts +3 -0
- package/dist/api/types/TriggerType.d.ts +1 -15
- package/dist/api/types/WebhookList.d.ts +1 -1
- package/dist/api/types/index.d.ts +12 -0
- package/dist/api/types/index.js +12 -0
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -0
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.js +2 -0
- package/dist/serialization/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/collections/resources/fields/client/requests/index.js +1 -3
- package/dist/serialization/resources/collections/resources/fields/index.d.ts +0 -1
- package/dist/serialization/resources/collections/resources/fields/index.js +0 -1
- package/dist/serialization/resources/collections/resources/index.d.ts +1 -2
- package/dist/serialization/resources/collections/resources/index.js +2 -3
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +1 -1
- package/dist/serialization/types/Assets.d.ts +2 -0
- package/dist/serialization/types/Assets.js +2 -0
- package/dist/serialization/types/Conflict.d.ts +10 -0
- package/dist/serialization/types/Conflict.js +31 -0
- package/dist/serialization/types/Dom.d.ts +1 -0
- package/dist/serialization/types/Dom.js +1 -0
- package/dist/serialization/types/FieldCreate.d.ts +13 -0
- package/dist/serialization/types/FieldCreate.js +34 -0
- package/dist/serialization/types/FieldType.d.ts +1 -1
- package/dist/serialization/types/FieldType.js +2 -0
- package/dist/serialization/types/Metadata.d.ts +13 -0
- package/dist/serialization/types/Metadata.js +34 -0
- package/dist/serialization/types/MetadataOptionsItem.d.ts +13 -0
- package/dist/serialization/types/MetadataOptionsItem.js +34 -0
- package/dist/serialization/types/OptionField.d.ts +19 -0
- package/dist/serialization/types/OptionField.js +40 -0
- package/dist/serialization/types/ReferenceField.d.ts +20 -0
- package/dist/serialization/types/ReferenceField.js +41 -0
- package/dist/serialization/types/ReferenceFieldMetadata.d.ts +12 -0
- package/dist/serialization/types/ReferenceFieldMetadata.js +33 -0
- package/dist/serialization/types/ReferenceFieldType.d.ts +10 -0
- package/dist/serialization/types/ReferenceFieldType.js +31 -0
- package/dist/serialization/types/Robots.d.ts +14 -0
- package/dist/serialization/types/Robots.js +35 -0
- package/dist/serialization/types/RobotsRulesItem.d.ts +14 -0
- package/dist/serialization/types/RobotsRulesItem.js +35 -0
- package/dist/serialization/types/StaticField.d.ts +18 -0
- package/dist/serialization/{resources/collections/resources/fields/client/requests/FieldCreate.js → types/StaticField.js} +7 -5
- package/dist/serialization/types/StaticFieldType.d.ts +10 -0
- package/dist/serialization/{resources/collections/resources/fields/types/FieldCreateType.js → types/StaticFieldType.js} +3 -4
- package/dist/serialization/types/WebhookList.d.ts +2 -2
- package/dist/serialization/types/WebhookList.js +2 -2
- package/dist/serialization/types/index.d.ts +12 -0
- package/dist/serialization/types/index.js +12 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/WebflowClient.d.ts +3 -0
- package/dist/wrapper/WebflowClient.js +5 -0
- package/dist/wrapper/WebhooksClient.d.ts +39 -0
- package/dist/wrapper/WebhooksClient.js +66 -0
- package/package.json +5 -3
- package/reference.md +585 -91
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -0
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.js +2 -0
- package/serialization/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/client/requests/index.js +1 -3
- package/serialization/resources/collections/resources/fields/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/index.js +0 -1
- package/serialization/resources/collections/resources/index.d.ts +1 -2
- package/serialization/resources/collections/resources/index.js +2 -3
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +1 -1
- package/serialization/types/Assets.d.ts +2 -0
- package/serialization/types/Assets.js +2 -0
- package/serialization/types/Conflict.d.ts +10 -0
- package/serialization/types/Conflict.js +31 -0
- package/serialization/types/Dom.d.ts +1 -0
- package/serialization/types/Dom.js +1 -0
- package/serialization/types/FieldCreate.d.ts +13 -0
- package/serialization/types/FieldCreate.js +34 -0
- package/serialization/types/FieldType.d.ts +1 -1
- package/serialization/types/FieldType.js +2 -0
- package/serialization/types/Metadata.d.ts +13 -0
- package/serialization/types/Metadata.js +34 -0
- package/serialization/types/MetadataOptionsItem.d.ts +13 -0
- package/serialization/types/MetadataOptionsItem.js +34 -0
- package/serialization/types/OptionField.d.ts +19 -0
- package/serialization/types/OptionField.js +40 -0
- package/serialization/types/ReferenceField.d.ts +20 -0
- package/serialization/types/ReferenceField.js +41 -0
- package/serialization/types/ReferenceFieldMetadata.d.ts +12 -0
- package/serialization/types/ReferenceFieldMetadata.js +33 -0
- package/serialization/types/ReferenceFieldType.d.ts +10 -0
- package/serialization/types/ReferenceFieldType.js +31 -0
- package/serialization/types/Robots.d.ts +14 -0
- package/serialization/types/Robots.js +35 -0
- package/serialization/types/RobotsRulesItem.d.ts +14 -0
- package/serialization/types/RobotsRulesItem.js +35 -0
- package/serialization/types/StaticField.d.ts +18 -0
- package/serialization/{resources/collections/resources/fields/client/requests/FieldCreate.js → types/StaticField.js} +7 -5
- package/serialization/types/StaticFieldType.d.ts +10 -0
- package/serialization/{resources/collections/resources/fields/types/FieldCreateType.js → types/StaticFieldType.js} +3 -4
- package/serialization/types/WebhookList.d.ts +2 -2
- package/serialization/types/WebhookList.js +2 -2
- package/serialization/types/index.d.ts +12 -0
- package/serialization/types/index.js +12 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/WebflowClient.d.ts +3 -0
- package/wrapper/WebflowClient.js +5 -0
- package/wrapper/WebhooksClient.d.ts +39 -0
- package/wrapper/WebhooksClient.js +66 -0
- package/api/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/types/index.js +0 -17
- package/dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +0 -16
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +0 -10
- package/dist/serialization/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +0 -16
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +0 -10
- package/serialization/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/types/index.js +0 -17
- /package/api/resources/{collections/resources/fields/client/requests/FieldCreate.js → forms/client/requests/FormsListSubmissionsBySiteRequest.js} +0 -0
- /package/{dist/api/resources/collections/resources/fields/client/requests/FieldCreate.js → api/types/Conflict.js} +0 -0
package/reference.md
CHANGED
|
@@ -130,7 +130,9 @@ await client.token.introspect();
|
|
|
130
130
|
<dl>
|
|
131
131
|
<dd>
|
|
132
132
|
|
|
133
|
-
Create a site.
|
|
133
|
+
Create a site.
|
|
134
|
+
|
|
135
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
134
136
|
|
|
135
137
|
Required scope | `workspace:write`
|
|
136
138
|
|
|
@@ -327,7 +329,9 @@ await client.sites.get("580e63e98c9a982ac9b8b741");
|
|
|
327
329
|
<dl>
|
|
328
330
|
<dd>
|
|
329
331
|
|
|
330
|
-
Delete a site.
|
|
332
|
+
Delete a site.
|
|
333
|
+
|
|
334
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
331
335
|
|
|
332
336
|
Required scope | `sites:write`
|
|
333
337
|
|
|
@@ -392,7 +396,9 @@ await client.sites.delete("580e63e98c9a982ac9b8b741");
|
|
|
392
396
|
<dl>
|
|
393
397
|
<dd>
|
|
394
398
|
|
|
395
|
-
Update a site.
|
|
399
|
+
Update a site.
|
|
400
|
+
|
|
401
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
396
402
|
|
|
397
403
|
Required scope | `sites:write`
|
|
398
404
|
|
|
@@ -694,6 +700,29 @@ await client.collections.create("580e63e98c9a982ac9b8b741", {
|
|
|
694
700
|
displayName: "Blog Posts",
|
|
695
701
|
singularName: "Blog Post",
|
|
696
702
|
slug: "posts",
|
|
703
|
+
fields: [
|
|
704
|
+
{
|
|
705
|
+
isRequired: true,
|
|
706
|
+
type: "PlainText",
|
|
707
|
+
displayName: "Title",
|
|
708
|
+
helpText: "The title of the blog post",
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
isRequired: true,
|
|
712
|
+
type: "RichText",
|
|
713
|
+
displayName: "Content",
|
|
714
|
+
helpText: "The content of the blog post",
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
isRequired: true,
|
|
718
|
+
type: "Reference",
|
|
719
|
+
displayName: "Author",
|
|
720
|
+
helpText: "The author of the blog post",
|
|
721
|
+
metadata: {
|
|
722
|
+
collectionId: "23cc2d952d4e4631ffd4345d2743db4e",
|
|
723
|
+
},
|
|
724
|
+
},
|
|
725
|
+
],
|
|
697
726
|
});
|
|
698
727
|
```
|
|
699
728
|
|
|
@@ -1033,6 +1062,10 @@ await client.pages.getMetadata("63c720f9347c2139b248e552", {
|
|
|
1033
1062
|
|
|
1034
1063
|
Update Page-level metadata, including SEO and Open Graph fields.
|
|
1035
1064
|
|
|
1065
|
+
<Note>
|
|
1066
|
+
Note: When updating Page Metadata in secondary locales, you may only add `slug` to the request if your Site has the [Advanced or Enterprise Localization](https://webflow.com/localization) add-on.
|
|
1067
|
+
</Note>
|
|
1068
|
+
|
|
1036
1069
|
Required scope | `pages:write`
|
|
1037
1070
|
|
|
1038
1071
|
</dd>
|
|
@@ -1131,10 +1164,11 @@ await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
|
|
|
1131
1164
|
<dl>
|
|
1132
1165
|
<dd>
|
|
1133
1166
|
|
|
1134
|
-
Get
|
|
1135
|
-
To retrieve the contents of components in the page use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint.
|
|
1167
|
+
Get content from a static page. This includes text nodes, image nodes, and component instances with [property overrides](https://help.webflow.com/hc/en-us/articles/33961219350547-Component-properties#how-to-modify-property-values-on-component-instances).
|
|
1136
1168
|
|
|
1137
|
-
|
|
1169
|
+
To retrieve the static content of a component instance, use the [Get Component Content](/data/reference/pages-and-components/components/get-content) endpoint.
|
|
1170
|
+
|
|
1171
|
+
<Note>If you do not include a `localeId` in your request, the response will return any content that can be localized from the Primary locale.</Note>
|
|
1138
1172
|
|
|
1139
1173
|
Required scope | `pages:read`
|
|
1140
1174
|
|
|
@@ -1592,9 +1626,9 @@ await client.components.updateContent("580e63e98c9a982ac9b8b741", "8505ba55-ef72
|
|
|
1592
1626
|
<dl>
|
|
1593
1627
|
<dd>
|
|
1594
1628
|
|
|
1595
|
-
Get the property
|
|
1629
|
+
Get the default property values of a component definition.
|
|
1596
1630
|
|
|
1597
|
-
<Note>If you do not
|
|
1631
|
+
<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>
|
|
1598
1632
|
|
|
1599
1633
|
Required scope | `components:read`
|
|
1600
1634
|
|
|
@@ -1677,13 +1711,11 @@ await client.components.getProperties("580e63e98c9a982ac9b8b741", "8505ba55-ef72
|
|
|
1677
1711
|
<dl>
|
|
1678
1712
|
<dd>
|
|
1679
1713
|
|
|
1680
|
-
Update the property
|
|
1681
|
-
|
|
1682
|
-
Before making updates:
|
|
1714
|
+
Update the default property values of a component definition in a specificed locale.
|
|
1683
1715
|
|
|
1684
|
-
|
|
1716
|
+
Before making updates, 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.
|
|
1685
1717
|
|
|
1686
|
-
<Note>The request requires a secondary locale ID. If a
|
|
1718
|
+
<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>
|
|
1687
1719
|
|
|
1688
1720
|
Required scope | `components:write`
|
|
1689
1721
|
|
|
@@ -1778,14 +1810,11 @@ await client.components.updateProperties("580e63e98c9a982ac9b8b741", "8505ba55-e
|
|
|
1778
1810
|
<dl>
|
|
1779
1811
|
<dd>
|
|
1780
1812
|
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1784
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1785
|
-
`custom_code` endpoints.
|
|
1786
|
-
Additionally, Scripts can be remotely hosted, or registered as inline snippets.
|
|
1813
|
+
Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts.
|
|
1787
1814
|
|
|
1788
|
-
<Note
|
|
1815
|
+
<Note title="Script Registration">
|
|
1816
|
+
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.
|
|
1817
|
+
</Note>
|
|
1789
1818
|
|
|
1790
1819
|
Required scope | `custom_code:read`
|
|
1791
1820
|
|
|
@@ -1850,14 +1879,11 @@ await client.scripts.list("580e63e98c9a982ac9b8b741");
|
|
|
1850
1879
|
<dl>
|
|
1851
1880
|
<dd>
|
|
1852
1881
|
|
|
1853
|
-
|
|
1882
|
+
Register a hosted script to a site.
|
|
1854
1883
|
|
|
1855
|
-
|
|
1856
|
-
to a
|
|
1857
|
-
|
|
1858
|
-
Additionally, Scripts can be remotely hosted, or registered as inline snippets.
|
|
1859
|
-
|
|
1860
|
-
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
1884
|
+
<Note title="Script Registration">
|
|
1885
|
+
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.
|
|
1886
|
+
</Note>
|
|
1861
1887
|
|
|
1862
1888
|
Required scope | `custom_code:write`
|
|
1863
1889
|
|
|
@@ -1935,13 +1961,11 @@ await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
|
|
|
1935
1961
|
<dl>
|
|
1936
1962
|
<dd>
|
|
1937
1963
|
|
|
1938
|
-
|
|
1939
|
-
|
|
1940
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
1941
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
1942
|
-
`custom_code` endpoints.
|
|
1964
|
+
Register an inline script to a site. Inline scripts are limited to 2000 characters.
|
|
1943
1965
|
|
|
1944
|
-
<Note
|
|
1966
|
+
<Note title="Script Registration">
|
|
1967
|
+
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.
|
|
1968
|
+
</Note>
|
|
1945
1969
|
|
|
1946
1970
|
Required scope | `custom_code:write`
|
|
1947
1971
|
|
|
@@ -2020,7 +2044,7 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
|
|
|
2020
2044
|
<dl>
|
|
2021
2045
|
<dd>
|
|
2022
2046
|
|
|
2023
|
-
List assets
|
|
2047
|
+
List of assets uploaded to a site
|
|
2024
2048
|
|
|
2025
2049
|
Required scope | `assets:read`
|
|
2026
2050
|
|
|
@@ -2085,11 +2109,13 @@ await client.assets.list("580e63e98c9a982ac9b8b741");
|
|
|
2085
2109
|
<dl>
|
|
2086
2110
|
<dd>
|
|
2087
2111
|
|
|
2088
|
-
|
|
2112
|
+
The first step in uploading an asset to a site.
|
|
2089
2113
|
|
|
2090
2114
|
This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
|
|
2091
|
-
|
|
2092
|
-
|
|
2115
|
+
|
|
2116
|
+
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.
|
|
2117
|
+
|
|
2118
|
+
To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets).
|
|
2093
2119
|
|
|
2094
2120
|
Required scope | `assets:write`
|
|
2095
2121
|
|
|
@@ -2165,7 +2191,7 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
|
|
|
2165
2191
|
<dl>
|
|
2166
2192
|
<dd>
|
|
2167
2193
|
|
|
2168
|
-
Get an
|
|
2194
|
+
Get details about an asset
|
|
2169
2195
|
|
|
2170
2196
|
Required scope | `assets:read`
|
|
2171
2197
|
|
|
@@ -2295,7 +2321,7 @@ await client.assets.delete("580e63fc8c9a982ac9b8b745");
|
|
|
2295
2321
|
<dl>
|
|
2296
2322
|
<dd>
|
|
2297
2323
|
|
|
2298
|
-
Update an Asset
|
|
2324
|
+
Update details of an Asset.
|
|
2299
2325
|
|
|
2300
2326
|
Required scope | `assets:write`
|
|
2301
2327
|
|
|
@@ -2996,6 +3022,12 @@ await client.forms.get("580e63e98c9a982ac9b8b741");
|
|
|
2996
3022
|
|
|
2997
3023
|
List form submissions for a given form
|
|
2998
3024
|
|
|
3025
|
+
<Note title="Forms in components">
|
|
3026
|
+
When a form is used in a component definition, each instance of the form is considered a unique form.
|
|
3027
|
+
|
|
3028
|
+
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.
|
|
3029
|
+
</Note>
|
|
3030
|
+
|
|
2999
3031
|
Required scope | `forms:read`
|
|
3000
3032
|
|
|
3001
3033
|
</dd>
|
|
@@ -3120,6 +3152,71 @@ await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
|
|
|
3120
3152
|
</dl>
|
|
3121
3153
|
</details>
|
|
3122
3154
|
|
|
3155
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">deleteSubmission</a>(formSubmissionId) -> void</code></summary>
|
|
3156
|
+
<dl>
|
|
3157
|
+
<dd>
|
|
3158
|
+
|
|
3159
|
+
#### 📝 Description
|
|
3160
|
+
|
|
3161
|
+
<dl>
|
|
3162
|
+
<dd>
|
|
3163
|
+
|
|
3164
|
+
<dl>
|
|
3165
|
+
<dd>
|
|
3166
|
+
|
|
3167
|
+
Delete a form submission
|
|
3168
|
+
|
|
3169
|
+
Required scope | `forms:write`
|
|
3170
|
+
|
|
3171
|
+
</dd>
|
|
3172
|
+
</dl>
|
|
3173
|
+
</dd>
|
|
3174
|
+
</dl>
|
|
3175
|
+
|
|
3176
|
+
#### 🔌 Usage
|
|
3177
|
+
|
|
3178
|
+
<dl>
|
|
3179
|
+
<dd>
|
|
3180
|
+
|
|
3181
|
+
<dl>
|
|
3182
|
+
<dd>
|
|
3183
|
+
|
|
3184
|
+
```typescript
|
|
3185
|
+
await client.forms.deleteSubmission("580e63e98c9a982ac9b8b741");
|
|
3186
|
+
```
|
|
3187
|
+
|
|
3188
|
+
</dd>
|
|
3189
|
+
</dl>
|
|
3190
|
+
</dd>
|
|
3191
|
+
</dl>
|
|
3192
|
+
|
|
3193
|
+
#### ⚙️ Parameters
|
|
3194
|
+
|
|
3195
|
+
<dl>
|
|
3196
|
+
<dd>
|
|
3197
|
+
|
|
3198
|
+
<dl>
|
|
3199
|
+
<dd>
|
|
3200
|
+
|
|
3201
|
+
**formSubmissionId:** `string` — Unique identifier for a Form Submission
|
|
3202
|
+
|
|
3203
|
+
</dd>
|
|
3204
|
+
</dl>
|
|
3205
|
+
|
|
3206
|
+
<dl>
|
|
3207
|
+
<dd>
|
|
3208
|
+
|
|
3209
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
3210
|
+
|
|
3211
|
+
</dd>
|
|
3212
|
+
</dl>
|
|
3213
|
+
</dd>
|
|
3214
|
+
</dl>
|
|
3215
|
+
|
|
3216
|
+
</dd>
|
|
3217
|
+
</dl>
|
|
3218
|
+
</details>
|
|
3219
|
+
|
|
3123
3220
|
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">updateSubmission</a>(formSubmissionId, { ...params }) -> Webflow.FormSubmission</code></summary>
|
|
3124
3221
|
<dl>
|
|
3125
3222
|
<dd>
|
|
@@ -3193,6 +3290,81 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
|
|
|
3193
3290
|
</dl>
|
|
3194
3291
|
</details>
|
|
3195
3292
|
|
|
3293
|
+
<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">listSubmissionsBySite</a>(siteId, { ...params }) -> Webflow.FormSubmissionList</code></summary>
|
|
3294
|
+
<dl>
|
|
3295
|
+
<dd>
|
|
3296
|
+
|
|
3297
|
+
#### 📝 Description
|
|
3298
|
+
|
|
3299
|
+
<dl>
|
|
3300
|
+
<dd>
|
|
3301
|
+
|
|
3302
|
+
<dl>
|
|
3303
|
+
<dd>
|
|
3304
|
+
|
|
3305
|
+
List form submissions for a given site. This endpoint differs from the existing [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) by accepting `siteId` as a path parameter and `elementId` as a query parameter. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list).
|
|
3306
|
+
|
|
3307
|
+
Required scope | `forms:read`
|
|
3308
|
+
|
|
3309
|
+
</dd>
|
|
3310
|
+
</dl>
|
|
3311
|
+
</dd>
|
|
3312
|
+
</dl>
|
|
3313
|
+
|
|
3314
|
+
#### 🔌 Usage
|
|
3315
|
+
|
|
3316
|
+
<dl>
|
|
3317
|
+
<dd>
|
|
3318
|
+
|
|
3319
|
+
<dl>
|
|
3320
|
+
<dd>
|
|
3321
|
+
|
|
3322
|
+
```typescript
|
|
3323
|
+
await client.forms.listSubmissionsBySite("580e63e98c9a982ac9b8b741", {
|
|
3324
|
+
elementId: "18259716-3e5a-646a-5f41-5dc4b9405aa0",
|
|
3325
|
+
});
|
|
3326
|
+
```
|
|
3327
|
+
|
|
3328
|
+
</dd>
|
|
3329
|
+
</dl>
|
|
3330
|
+
</dd>
|
|
3331
|
+
</dl>
|
|
3332
|
+
|
|
3333
|
+
#### ⚙️ Parameters
|
|
3334
|
+
|
|
3335
|
+
<dl>
|
|
3336
|
+
<dd>
|
|
3337
|
+
|
|
3338
|
+
<dl>
|
|
3339
|
+
<dd>
|
|
3340
|
+
|
|
3341
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
3342
|
+
|
|
3343
|
+
</dd>
|
|
3344
|
+
</dl>
|
|
3345
|
+
|
|
3346
|
+
<dl>
|
|
3347
|
+
<dd>
|
|
3348
|
+
|
|
3349
|
+
**request:** `Webflow.FormsListSubmissionsBySiteRequest`
|
|
3350
|
+
|
|
3351
|
+
</dd>
|
|
3352
|
+
</dl>
|
|
3353
|
+
|
|
3354
|
+
<dl>
|
|
3355
|
+
<dd>
|
|
3356
|
+
|
|
3357
|
+
**requestOptions:** `Forms.RequestOptions`
|
|
3358
|
+
|
|
3359
|
+
</dd>
|
|
3360
|
+
</dl>
|
|
3361
|
+
</dd>
|
|
3362
|
+
</dl>
|
|
3363
|
+
|
|
3364
|
+
</dd>
|
|
3365
|
+
</dl>
|
|
3366
|
+
</details>
|
|
3367
|
+
|
|
3196
3368
|
## Users
|
|
3197
3369
|
|
|
3198
3370
|
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.UserList</code></summary>
|
|
@@ -4856,7 +5028,7 @@ await client.ecommerce.getSettings("580e63e98c9a982ac9b8b741");
|
|
|
4856
5028
|
|
|
4857
5029
|
## Collections Fields
|
|
4858
5030
|
|
|
4859
|
-
<details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">create</a>(collectionId, { ...params }) -> Webflow.
|
|
5031
|
+
<details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">create</a>(collectionId, { ...params }) -> Webflow.FieldCreate</code></summary>
|
|
4860
5032
|
<dl>
|
|
4861
5033
|
<dd>
|
|
4862
5034
|
|
|
@@ -4873,8 +5045,6 @@ Create a custom field in a collection.
|
|
|
4873
5045
|
Slugs must be all lowercase letters without spaces.
|
|
4874
5046
|
If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will
|
|
4875
5047
|
convert the slug to lowercase and replace spaces with "-."
|
|
4876
|
-
|
|
4877
|
-
Only some field types can be created through the API.
|
|
4878
5048
|
This endpoint does not currently support bulk creation.
|
|
4879
5049
|
|
|
4880
5050
|
Required scope | `cms:write`
|
|
@@ -4894,6 +5064,7 @@ Required scope | `cms:write`
|
|
|
4894
5064
|
|
|
4895
5065
|
```typescript
|
|
4896
5066
|
await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
5067
|
+
isEditable: true,
|
|
4897
5068
|
isRequired: false,
|
|
4898
5069
|
type: "RichText",
|
|
4899
5070
|
displayName: "Post Body",
|
|
@@ -4922,7 +5093,7 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
|
|
|
4922
5093
|
<dl>
|
|
4923
5094
|
<dd>
|
|
4924
5095
|
|
|
4925
|
-
**request:** `Webflow.
|
|
5096
|
+
**request:** `Webflow.FieldCreate`
|
|
4926
5097
|
|
|
4927
5098
|
</dd>
|
|
4928
5099
|
</dl>
|
|
@@ -5270,7 +5441,7 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
|
|
|
5270
5441
|
|
|
5271
5442
|
Delete Items from a Collection.
|
|
5272
5443
|
|
|
5273
|
-
|
|
5444
|
+
<Tip title="Localization Tip">Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request.</Tip>
|
|
5274
5445
|
|
|
5275
5446
|
Required scope | `CMS:write`
|
|
5276
5447
|
|
|
@@ -5343,9 +5514,11 @@ await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
|
|
|
5343
5514
|
<dl>
|
|
5344
5515
|
<dd>
|
|
5345
5516
|
|
|
5346
|
-
Update a single item or multiple items
|
|
5517
|
+
Update a single item or multiple items in a Collection.
|
|
5518
|
+
|
|
5519
|
+
The limit for this endpoint is 100 items.
|
|
5347
5520
|
|
|
5348
|
-
|
|
5521
|
+
<Tip title="Localization Tip">Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.</Tip>
|
|
5349
5522
|
|
|
5350
5523
|
Required scope | `CMS:write`
|
|
5351
5524
|
|
|
@@ -5453,7 +5626,7 @@ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
|
|
|
5453
5626
|
<dl>
|
|
5454
5627
|
<dd>
|
|
5455
5628
|
|
|
5456
|
-
List
|
|
5629
|
+
List all published items in a collection.
|
|
5457
5630
|
|
|
5458
5631
|
Required scope | `CMS:read`
|
|
5459
5632
|
|
|
@@ -5526,7 +5699,7 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
5526
5699
|
<dl>
|
|
5527
5700
|
<dd>
|
|
5528
5701
|
|
|
5529
|
-
Create
|
|
5702
|
+
Create item(s) in a collection that will be immediately published to the live site.
|
|
5530
5703
|
|
|
5531
5704
|
To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items)
|
|
5532
5705
|
|
|
@@ -5608,9 +5781,11 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
|
|
|
5608
5781
|
<dl>
|
|
5609
5782
|
<dd>
|
|
5610
5783
|
|
|
5611
|
-
Remove an item or multiple items (up to 100 items) from the live site.
|
|
5784
|
+
Remove an item or multiple items (up to 100 items) from the live site.
|
|
5612
5785
|
|
|
5613
|
-
|
|
5786
|
+
Using this endpoint to delete published item(s) will unpublish the item(s) from the live site and set the item(s) `isDraft` property to `true`.
|
|
5787
|
+
|
|
5788
|
+
<Tip title="Localization Tip">Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request.</Tip>
|
|
5614
5789
|
|
|
5615
5790
|
Required scope | `CMS:write`
|
|
5616
5791
|
|
|
@@ -5683,9 +5858,9 @@ await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745");
|
|
|
5683
5858
|
<dl>
|
|
5684
5859
|
<dd>
|
|
5685
5860
|
|
|
5686
|
-
Update a single
|
|
5861
|
+
Update a single published item or multiple published items (up to 100) in a Collection
|
|
5687
5862
|
|
|
5688
|
-
|
|
5863
|
+
<Tip title="Localization Tip">Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request.</Tip>
|
|
5689
5864
|
|
|
5690
5865
|
Required scope | `CMS:write`
|
|
5691
5866
|
|
|
@@ -5795,10 +5970,10 @@ await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
|
|
|
5795
5970
|
|
|
5796
5971
|
Create an item or multiple items in a CMS Collection across multiple corresponding locales.
|
|
5797
5972
|
|
|
5798
|
-
|
|
5799
|
-
|
|
5800
|
-
-
|
|
5801
|
-
|
|
5973
|
+
<Note>
|
|
5974
|
+
- This endpoint can create up to 100 items in a request.
|
|
5975
|
+
- If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.
|
|
5976
|
+
</Note>
|
|
5802
5977
|
|
|
5803
5978
|
Required scope | `CMS:write`
|
|
5804
5979
|
|
|
@@ -5960,7 +6135,7 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
|
|
|
5960
6135
|
<dl>
|
|
5961
6136
|
<dd>
|
|
5962
6137
|
|
|
5963
|
-
Delete an
|
|
6138
|
+
Delete an item from a collection.
|
|
5964
6139
|
|
|
5965
6140
|
Required scope | `CMS:write`
|
|
5966
6141
|
|
|
@@ -6458,13 +6633,7 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
|
|
|
6458
6633
|
<dl>
|
|
6459
6634
|
<dd>
|
|
6460
6635
|
|
|
6461
|
-
Get all
|
|
6462
|
-
|
|
6463
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
6464
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6465
|
-
`custom_code` endpoints.
|
|
6466
|
-
|
|
6467
|
-
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6636
|
+
Get all scripts applied to a page.
|
|
6468
6637
|
|
|
6469
6638
|
Required scope | `custom_code:read`
|
|
6470
6639
|
|
|
@@ -6529,15 +6698,11 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
|
|
|
6529
6698
|
<dl>
|
|
6530
6699
|
<dd>
|
|
6531
6700
|
|
|
6532
|
-
|
|
6533
|
-
|
|
6534
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
6535
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6536
|
-
`custom_code` endpoints.
|
|
6537
|
-
|
|
6538
|
-
A site can have a maximum of 800 registered scripts.
|
|
6701
|
+
Apply scripts to a page.
|
|
6539
6702
|
|
|
6540
|
-
<Note
|
|
6703
|
+
<Note title="Script Registration">
|
|
6704
|
+
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.
|
|
6705
|
+
</Note>
|
|
6541
6706
|
|
|
6542
6707
|
Required scope | `custom_code:write`
|
|
6543
6708
|
|
|
@@ -6626,11 +6791,7 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
|
|
|
6626
6791
|
<dl>
|
|
6627
6792
|
<dd>
|
|
6628
6793
|
|
|
6629
|
-
Delete
|
|
6630
|
-
|
|
6631
|
-
In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
|
|
6632
|
-
to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
|
|
6633
|
-
`custom_code` endpoints.
|
|
6794
|
+
Delete a custom code block that the App created on a page.
|
|
6634
6795
|
|
|
6635
6796
|
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
6636
6797
|
|
|
@@ -6703,6 +6864,8 @@ Fetch a list of all URL redirect rules configured for a specific site.
|
|
|
6703
6864
|
|
|
6704
6865
|
Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
|
|
6705
6866
|
|
|
6867
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
6868
|
+
|
|
6706
6869
|
Required scope: `sites:read`
|
|
6707
6870
|
|
|
6708
6871
|
</dd>
|
|
@@ -6770,6 +6933,8 @@ Add a new URL redirection rule to a site.
|
|
|
6770
6933
|
|
|
6771
6934
|
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.
|
|
6772
6935
|
|
|
6936
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
6937
|
+
|
|
6773
6938
|
Required scope: `sites:write`
|
|
6774
6939
|
|
|
6775
6940
|
</dd>
|
|
@@ -6846,7 +7011,11 @@ await client.sites.redirects.create("580e63e98c9a982ac9b8b741", {
|
|
|
6846
7011
|
<dd>
|
|
6847
7012
|
|
|
6848
7013
|
Remove a URL redirection rule from a site.
|
|
7014
|
+
|
|
6849
7015
|
This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.
|
|
7016
|
+
|
|
7017
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
7018
|
+
|
|
6850
7019
|
Required scope: `sites:write`
|
|
6851
7020
|
|
|
6852
7021
|
</dd>
|
|
@@ -6919,6 +7088,9 @@ await client.sites.redirects.delete("580e63e98c9a982ac9b8b741", "66c4cb9a20cac35
|
|
|
6919
7088
|
<dd>
|
|
6920
7089
|
|
|
6921
7090
|
Update a URL redirection rule from a site.
|
|
7091
|
+
|
|
7092
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
7093
|
+
|
|
6922
7094
|
Required scope: `sites:write`
|
|
6923
7095
|
|
|
6924
7096
|
</dd>
|
|
@@ -7006,6 +7178,8 @@ await client.sites.redirects.update("580e63e98c9a982ac9b8b741", "66c4cb9a20cac35
|
|
|
7006
7178
|
|
|
7007
7179
|
Get site plan details for the specified Site.
|
|
7008
7180
|
|
|
7181
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
7182
|
+
|
|
7009
7183
|
Required scope | `sites:read`
|
|
7010
7184
|
|
|
7011
7185
|
</dd>
|
|
@@ -7057,6 +7231,320 @@ await client.sites.plans.getSitePlan("580e63e98c9a982ac9b8b741");
|
|
|
7057
7231
|
</dl>
|
|
7058
7232
|
</details>
|
|
7059
7233
|
|
|
7234
|
+
## Sites RobotsTxt
|
|
7235
|
+
|
|
7236
|
+
<details><summary><code>client.sites.robotsTxt.<a href="/src/api/resources/sites/resources/robotsTxt/client/Client.ts">get</a>(siteId) -> Webflow.Robots</code></summary>
|
|
7237
|
+
<dl>
|
|
7238
|
+
<dd>
|
|
7239
|
+
|
|
7240
|
+
#### 📝 Description
|
|
7241
|
+
|
|
7242
|
+
<dl>
|
|
7243
|
+
<dd>
|
|
7244
|
+
|
|
7245
|
+
<dl>
|
|
7246
|
+
<dd>
|
|
7247
|
+
|
|
7248
|
+
Retrieve the robots.txt configuration for various user agents.
|
|
7249
|
+
|
|
7250
|
+
Required scope: `site_config:read`
|
|
7251
|
+
|
|
7252
|
+
</dd>
|
|
7253
|
+
</dl>
|
|
7254
|
+
</dd>
|
|
7255
|
+
</dl>
|
|
7256
|
+
|
|
7257
|
+
#### 🔌 Usage
|
|
7258
|
+
|
|
7259
|
+
<dl>
|
|
7260
|
+
<dd>
|
|
7261
|
+
|
|
7262
|
+
<dl>
|
|
7263
|
+
<dd>
|
|
7264
|
+
|
|
7265
|
+
```typescript
|
|
7266
|
+
await client.sites.robotsTxt.get("580e63e98c9a982ac9b8b741");
|
|
7267
|
+
```
|
|
7268
|
+
|
|
7269
|
+
</dd>
|
|
7270
|
+
</dl>
|
|
7271
|
+
</dd>
|
|
7272
|
+
</dl>
|
|
7273
|
+
|
|
7274
|
+
#### ⚙️ Parameters
|
|
7275
|
+
|
|
7276
|
+
<dl>
|
|
7277
|
+
<dd>
|
|
7278
|
+
|
|
7279
|
+
<dl>
|
|
7280
|
+
<dd>
|
|
7281
|
+
|
|
7282
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
7283
|
+
|
|
7284
|
+
</dd>
|
|
7285
|
+
</dl>
|
|
7286
|
+
|
|
7287
|
+
<dl>
|
|
7288
|
+
<dd>
|
|
7289
|
+
|
|
7290
|
+
**requestOptions:** `RobotsTxt.RequestOptions`
|
|
7291
|
+
|
|
7292
|
+
</dd>
|
|
7293
|
+
</dl>
|
|
7294
|
+
</dd>
|
|
7295
|
+
</dl>
|
|
7296
|
+
|
|
7297
|
+
</dd>
|
|
7298
|
+
</dl>
|
|
7299
|
+
</details>
|
|
7300
|
+
|
|
7301
|
+
<details><summary><code>client.sites.robotsTxt.<a href="/src/api/resources/sites/resources/robotsTxt/client/Client.ts">put</a>(siteId, { ...params }) -> Webflow.Robots</code></summary>
|
|
7302
|
+
<dl>
|
|
7303
|
+
<dd>
|
|
7304
|
+
|
|
7305
|
+
#### 📝 Description
|
|
7306
|
+
|
|
7307
|
+
<dl>
|
|
7308
|
+
<dd>
|
|
7309
|
+
|
|
7310
|
+
<dl>
|
|
7311
|
+
<dd>
|
|
7312
|
+
|
|
7313
|
+
Replace the `robots.txt` configuration for various user agents.
|
|
7314
|
+
|
|
7315
|
+
Required scope | `site_config:write`
|
|
7316
|
+
|
|
7317
|
+
</dd>
|
|
7318
|
+
</dl>
|
|
7319
|
+
</dd>
|
|
7320
|
+
</dl>
|
|
7321
|
+
|
|
7322
|
+
#### 🔌 Usage
|
|
7323
|
+
|
|
7324
|
+
<dl>
|
|
7325
|
+
<dd>
|
|
7326
|
+
|
|
7327
|
+
<dl>
|
|
7328
|
+
<dd>
|
|
7329
|
+
|
|
7330
|
+
```typescript
|
|
7331
|
+
await client.sites.robotsTxt.put("580e63e98c9a982ac9b8b741", {
|
|
7332
|
+
rules: [
|
|
7333
|
+
{
|
|
7334
|
+
userAgent: "googlebot",
|
|
7335
|
+
allows: ["/public"],
|
|
7336
|
+
disallows: ["/vogon-poetry", "/total-perspective-vortex"],
|
|
7337
|
+
},
|
|
7338
|
+
],
|
|
7339
|
+
sitemap: "https://heartofgold.ship/sitemap.xml",
|
|
7340
|
+
});
|
|
7341
|
+
```
|
|
7342
|
+
|
|
7343
|
+
</dd>
|
|
7344
|
+
</dl>
|
|
7345
|
+
</dd>
|
|
7346
|
+
</dl>
|
|
7347
|
+
|
|
7348
|
+
#### ⚙️ Parameters
|
|
7349
|
+
|
|
7350
|
+
<dl>
|
|
7351
|
+
<dd>
|
|
7352
|
+
|
|
7353
|
+
<dl>
|
|
7354
|
+
<dd>
|
|
7355
|
+
|
|
7356
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
7357
|
+
|
|
7358
|
+
</dd>
|
|
7359
|
+
</dl>
|
|
7360
|
+
|
|
7361
|
+
<dl>
|
|
7362
|
+
<dd>
|
|
7363
|
+
|
|
7364
|
+
**request:** `Webflow.Robots`
|
|
7365
|
+
|
|
7366
|
+
</dd>
|
|
7367
|
+
</dl>
|
|
7368
|
+
|
|
7369
|
+
<dl>
|
|
7370
|
+
<dd>
|
|
7371
|
+
|
|
7372
|
+
**requestOptions:** `RobotsTxt.RequestOptions`
|
|
7373
|
+
|
|
7374
|
+
</dd>
|
|
7375
|
+
</dl>
|
|
7376
|
+
</dd>
|
|
7377
|
+
</dl>
|
|
7378
|
+
|
|
7379
|
+
</dd>
|
|
7380
|
+
</dl>
|
|
7381
|
+
</details>
|
|
7382
|
+
|
|
7383
|
+
<details><summary><code>client.sites.robotsTxt.<a href="/src/api/resources/sites/resources/robotsTxt/client/Client.ts">delete</a>(siteId, { ...params }) -> Webflow.Robots</code></summary>
|
|
7384
|
+
<dl>
|
|
7385
|
+
<dd>
|
|
7386
|
+
|
|
7387
|
+
#### 📝 Description
|
|
7388
|
+
|
|
7389
|
+
<dl>
|
|
7390
|
+
<dd>
|
|
7391
|
+
|
|
7392
|
+
<dl>
|
|
7393
|
+
<dd>
|
|
7394
|
+
|
|
7395
|
+
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.
|
|
7396
|
+
|
|
7397
|
+
**Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply.
|
|
7398
|
+
|
|
7399
|
+
Required scope: `site_config:write`
|
|
7400
|
+
|
|
7401
|
+
</dd>
|
|
7402
|
+
</dl>
|
|
7403
|
+
</dd>
|
|
7404
|
+
</dl>
|
|
7405
|
+
|
|
7406
|
+
#### 🔌 Usage
|
|
7407
|
+
|
|
7408
|
+
<dl>
|
|
7409
|
+
<dd>
|
|
7410
|
+
|
|
7411
|
+
<dl>
|
|
7412
|
+
<dd>
|
|
7413
|
+
|
|
7414
|
+
```typescript
|
|
7415
|
+
await client.sites.robotsTxt.delete("580e63e98c9a982ac9b8b741", {
|
|
7416
|
+
rules: [
|
|
7417
|
+
{
|
|
7418
|
+
userAgent: "*",
|
|
7419
|
+
allows: ["/public"],
|
|
7420
|
+
disallows: ["/bubbles"],
|
|
7421
|
+
},
|
|
7422
|
+
],
|
|
7423
|
+
});
|
|
7424
|
+
```
|
|
7425
|
+
|
|
7426
|
+
</dd>
|
|
7427
|
+
</dl>
|
|
7428
|
+
</dd>
|
|
7429
|
+
</dl>
|
|
7430
|
+
|
|
7431
|
+
#### ⚙️ Parameters
|
|
7432
|
+
|
|
7433
|
+
<dl>
|
|
7434
|
+
<dd>
|
|
7435
|
+
|
|
7436
|
+
<dl>
|
|
7437
|
+
<dd>
|
|
7438
|
+
|
|
7439
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
7440
|
+
|
|
7441
|
+
</dd>
|
|
7442
|
+
</dl>
|
|
7443
|
+
|
|
7444
|
+
<dl>
|
|
7445
|
+
<dd>
|
|
7446
|
+
|
|
7447
|
+
**request:** `Webflow.Robots`
|
|
7448
|
+
|
|
7449
|
+
</dd>
|
|
7450
|
+
</dl>
|
|
7451
|
+
|
|
7452
|
+
<dl>
|
|
7453
|
+
<dd>
|
|
7454
|
+
|
|
7455
|
+
**requestOptions:** `RobotsTxt.RequestOptions`
|
|
7456
|
+
|
|
7457
|
+
</dd>
|
|
7458
|
+
</dl>
|
|
7459
|
+
</dd>
|
|
7460
|
+
</dl>
|
|
7461
|
+
|
|
7462
|
+
</dd>
|
|
7463
|
+
</dl>
|
|
7464
|
+
</details>
|
|
7465
|
+
|
|
7466
|
+
<details><summary><code>client.sites.robotsTxt.<a href="/src/api/resources/sites/resources/robotsTxt/client/Client.ts">patch</a>(siteId, { ...params }) -> Webflow.Robots</code></summary>
|
|
7467
|
+
<dl>
|
|
7468
|
+
<dd>
|
|
7469
|
+
|
|
7470
|
+
#### 📝 Description
|
|
7471
|
+
|
|
7472
|
+
<dl>
|
|
7473
|
+
<dd>
|
|
7474
|
+
|
|
7475
|
+
<dl>
|
|
7476
|
+
<dd>
|
|
7477
|
+
|
|
7478
|
+
Update the `robots.txt` configuration for various user agents.
|
|
7479
|
+
|
|
7480
|
+
Required scope | `site_config:write`
|
|
7481
|
+
|
|
7482
|
+
</dd>
|
|
7483
|
+
</dl>
|
|
7484
|
+
</dd>
|
|
7485
|
+
</dl>
|
|
7486
|
+
|
|
7487
|
+
#### 🔌 Usage
|
|
7488
|
+
|
|
7489
|
+
<dl>
|
|
7490
|
+
<dd>
|
|
7491
|
+
|
|
7492
|
+
<dl>
|
|
7493
|
+
<dd>
|
|
7494
|
+
|
|
7495
|
+
```typescript
|
|
7496
|
+
await client.sites.robotsTxt.patch("580e63e98c9a982ac9b8b741", {
|
|
7497
|
+
rules: [
|
|
7498
|
+
{
|
|
7499
|
+
userAgent: "googlebot",
|
|
7500
|
+
allows: ["/public"],
|
|
7501
|
+
disallows: ["/vogon-poetry", "/total-perspective-vortex"],
|
|
7502
|
+
},
|
|
7503
|
+
],
|
|
7504
|
+
sitemap: "https://heartofgold.ship/sitemap.xml",
|
|
7505
|
+
});
|
|
7506
|
+
```
|
|
7507
|
+
|
|
7508
|
+
</dd>
|
|
7509
|
+
</dl>
|
|
7510
|
+
</dd>
|
|
7511
|
+
</dl>
|
|
7512
|
+
|
|
7513
|
+
#### ⚙️ Parameters
|
|
7514
|
+
|
|
7515
|
+
<dl>
|
|
7516
|
+
<dd>
|
|
7517
|
+
|
|
7518
|
+
<dl>
|
|
7519
|
+
<dd>
|
|
7520
|
+
|
|
7521
|
+
**siteId:** `string` — Unique identifier for a Site
|
|
7522
|
+
|
|
7523
|
+
</dd>
|
|
7524
|
+
</dl>
|
|
7525
|
+
|
|
7526
|
+
<dl>
|
|
7527
|
+
<dd>
|
|
7528
|
+
|
|
7529
|
+
**request:** `Webflow.Robots`
|
|
7530
|
+
|
|
7531
|
+
</dd>
|
|
7532
|
+
</dl>
|
|
7533
|
+
|
|
7534
|
+
<dl>
|
|
7535
|
+
<dd>
|
|
7536
|
+
|
|
7537
|
+
**requestOptions:** `RobotsTxt.RequestOptions`
|
|
7538
|
+
|
|
7539
|
+
</dd>
|
|
7540
|
+
</dl>
|
|
7541
|
+
</dd>
|
|
7542
|
+
</dl>
|
|
7543
|
+
|
|
7544
|
+
</dd>
|
|
7545
|
+
</dl>
|
|
7546
|
+
</details>
|
|
7547
|
+
|
|
7060
7548
|
## Sites ActivityLogs
|
|
7061
7549
|
|
|
7062
7550
|
<details><summary><code>client.sites.activityLogs.<a href="/src/api/resources/sites/resources/activityLogs/client/Client.ts">list</a>(siteId, { ...params }) -> Webflow.SiteActivityLogResponse</code></summary>
|
|
@@ -7071,7 +7559,11 @@ await client.sites.plans.getSitePlan("580e63e98c9a982ac9b8b741");
|
|
|
7071
7559
|
<dl>
|
|
7072
7560
|
<dd>
|
|
7073
7561
|
|
|
7074
|
-
Retrieve Activity Logs for a specific Site.
|
|
7562
|
+
Retrieve Activity Logs for a specific Site.
|
|
7563
|
+
|
|
7564
|
+
<Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
7565
|
+
|
|
7566
|
+
Required scope: `site_activity:read`
|
|
7075
7567
|
|
|
7076
7568
|
</dd>
|
|
7077
7569
|
</dl>
|
|
@@ -7144,9 +7636,11 @@ await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741");
|
|
|
7144
7636
|
<dl>
|
|
7145
7637
|
<dd>
|
|
7146
7638
|
|
|
7147
|
-
Get all
|
|
7639
|
+
Get all scripts applied to a site by the App.
|
|
7148
7640
|
|
|
7149
|
-
<Note
|
|
7641
|
+
<Note title="Script Registration">
|
|
7642
|
+
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.
|
|
7643
|
+
</Note>
|
|
7150
7644
|
|
|
7151
7645
|
Required scope | `custom_code:read`
|
|
7152
7646
|
|
|
@@ -7211,13 +7705,11 @@ await client.sites.scripts.getCustomCode("580e63e98c9a982ac9b8b741");
|
|
|
7211
7705
|
<dl>
|
|
7212
7706
|
<dd>
|
|
7213
7707
|
|
|
7214
|
-
|
|
7708
|
+
Apply registered scripts to a site.
|
|
7215
7709
|
|
|
7216
|
-
|
|
7217
|
-
to a
|
|
7218
|
-
|
|
7219
|
-
|
|
7220
|
-
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
7710
|
+
<Note title="Script Registration">
|
|
7711
|
+
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.
|
|
7712
|
+
</Note>
|
|
7221
7713
|
|
|
7222
7714
|
Required scope | `custom_code:write`
|
|
7223
7715
|
|
|
@@ -7306,9 +7798,7 @@ await client.sites.scripts.upsertCustomCode("580e63e98c9a982ac9b8b741", {
|
|
|
7306
7798
|
<dl>
|
|
7307
7799
|
<dd>
|
|
7308
7800
|
|
|
7309
|
-
|
|
7310
|
-
|
|
7311
|
-
<Note>Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients).</Note>
|
|
7801
|
+
Remove scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts.
|
|
7312
7802
|
|
|
7313
7803
|
Required scope | `custom_code:write`
|
|
7314
7804
|
|
|
@@ -7373,9 +7863,13 @@ await client.sites.scripts.deleteCustomCode("580e63e98c9a982ac9b8b741");
|
|
|
7373
7863
|
<dl>
|
|
7374
7864
|
<dd>
|
|
7375
7865
|
|
|
7376
|
-
Get
|
|
7866
|
+
Get a list of scripts that have been applied to a site and/or individual pages.
|
|
7377
7867
|
|
|
7378
|
-
<Note
|
|
7868
|
+
<Note title="Script Registration">
|
|
7869
|
+
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.
|
|
7870
|
+
|
|
7871
|
+
See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
|
|
7872
|
+
</Note>
|
|
7379
7873
|
|
|
7380
7874
|
Required scope | `custom_code:read`
|
|
7381
7875
|
|