openapi: 3.1.0 info: title: Webflow Assets Asset Folders Sites API description: Webflow Data API v2 - Assets endpoints. version: 2.0.0 contact: name: Webflow Developer Relations email: developers@webflow.com url: https://developers.webflow.com termsOfService: https://webflow.com/legal/terms license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.webflow.com/v2 description: Webflow API v2 x-fern-server-name: Data API security: - OAuth2: [] - ApiKey: [] tags: - name: Sites description: Sites are the sites in your Webflow workspace. paths: /sites/{site_id}/collections: get: x-fern-sdk-group-name: collections x-fern-sdk-method-name: list security: - OAuth2: - cms:read operationId: list-collections summary: Webflow List Collections description: 'List of all Collections within a Site. Required scope | `cms:read` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object example: collections: - id: 63692ab61fb2852f582ba8f5 displayName: Products singularName: Product slug: product createdOn: '2019-06-12T13:35:14.238Z' lastUpdated: '2022-11-17T15:08:50.480Z' - id: 63692ab61fb2856e6a2ba8f6 displayName: Categories singularName: Category slug: category createdOn: '2019-06-12T13:35:14.238Z' lastUpdated: '2022-11-17T15:08:50.481Z' - id: 63692ab61fb285a8562ba8f4 displayName: SKUs singularName: SKU slug: sku createdOn: '2019-06-12T13:35:14.238Z' lastUpdated: '2022-11-17T15:08:50.478Z' properties: collections: description: An array of Collections type: array items: example: id: 7f15043107e2fc95644e93807ee25dd6 displayName: Guide Entries singularName: Guide Entry fields: - id: 5e2a1b3c4d5e6f7890a1b2c3 isEditable: true isRequired: true type: PlainText slug: name displayName: Entry Title helpText: Name of the entry. validations: null - id: 5e2a1b3c4d5e6f7890a1b2c4 isEditable: true isRequired: true type: PlainText slug: slug displayName: Slug helpText: Slug of the entry. validations: null - id: 6f7e8d9c0b1a2e3d4c5b6a7f isEditable: true isRequired: false type: PlainText slug: summary displayName: Summary helpText: A short summary of the entry. validations: null - id: 1a2b3c4d5e6f7a8b9c0d1e2f isEditable: true isRequired: false type: RichText slug: entry-html displayName: Entry HTML helpText: The HTML content of the entry. validations: null - id: 7e8d9c0b1a2e3d4c5b6a7f8e isEditable: true isRequired: false type: Image slug: illustration-image displayName: Illustration Image helpText: An image of the entry. validations: null - id: 2f3e4d5c6b7a8e9d0c1b2a3f isEditable: true isRequired: false type: VideoLink slug: demonstration-video displayName: Demonstration Video helpText: A video of the entry. validations: null - id: 8e9d0c1b2a3f4e5d6c7b8a9e isEditable: true isRequired: false type: Link slug: more-info-link displayName: More Info Link helpText: A link to more information about the entry. validations: null - id: 3f4e5d6c7b8a9e0d1c2b3a4f isEditable: true isRequired: false type: Number slug: importance-level displayName: Importance Level helpText: The importance level of the entry. validations: format: integer allowNegative: false allowZero: false minValue: 1 maxValue: 5 - id: 9e0d1c2b3a4f5e6d7c8b9a0e isEditable: true isRequired: false type: Switch slug: is-essential displayName: Is Essential helpText: Is this entry essential? validations: null - id: 4f5e6d7c8b9a0e1d2c3b4a5f isEditable: true isRequired: false type: Date slug: first-mentioned displayName: First Mentioned helpText: Date of the first mention of the subject. validations: null - id: 0e1d2c3b4a5f6e7d8c9b0a1e isEditable: true isRequired: false type: Color slug: towel-color displayName: Towel Color helpText: The color of the towel. validations: null - id: 5f6e7d8c9b0a1e2d3c4b5a6f isEditable: true isRequired: false type: Reference slug: related-entry displayName: Related Entry helpText: A related entry. validations: collectionId: 7f15043107e2fc95644e93807ee25dd6 - id: 1e2d3c4b5a6f7e8d9c0b1a2f isEditable: true isRequired: false type: MultiReference slug: mentioned-in-entries displayName: Mentioned In Entries helpText: Entries that mention this subject. validations: collectionId: 7f15043107e2fc95644e93807ee25dd6 - id: 6f7e8d9c0b1a2e3d4c5b6a8f isEditable: true isRequired: false type: Option slug: item-type displayName: Item Type helpText: The type of item. validations: options: - name: Survival Gear id: 66f6e966c9e1dc700a857ca3 - name: Gadget id: 66f6e966c9e1dc700a857ca4 - name: Other id: 66f6e966c9e1dc700a857ca5 - id: 2e3d4c5b6a7f8e9d0c1b2a4f isEditable: true isRequired: false type: File slug: guide-file displayName: Guide File helpText: null validations: null - id: 7f8e9d0c1b2a3f4e5d6c8b9e isEditable: true isRequired: false type: Email slug: contributor-email displayName: Contributor Email helpText: null validations: null - id: 3a4f5e6d7c8b9a0e1d2c4b5f isEditable: true isRequired: false type: Phone slug: emergency-contact displayName: Emergency Contact helpText: null validations: null slug: guide-entry createdOn: '2024-04-12T12:42:00.000Z' lastUpdated: '2024-04-12T12:42:00.000Z' description: A collection object type: object required: - id properties: id: type: string format: objectid description: Unique identifier for a Collection example: 562ac0395358780a1f5e6fbd displayName: type: string example: Blog Posts description: Name given to the Collection singularName: type: string example: Blog Post description: The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) slug: type: string example: blog-posts description: Slug of Collection in Site URL structure createdOn: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true description: The date the collection was created lastUpdated: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true description: The date the collection was last updated '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] post: x-fern-sdk-group-name: collections x-fern-sdk-method-name: create security: - OAuth2: - cms:write operationId: create-collection summary: Webflow Create Collection description: '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` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: description: Pass the Name of the collection, as well as the singular name of each item in the collection. required: true content: application/json: schema: type: object required: - displayName - singularName properties: displayName: type: string description: Name of the collection. Each collection name must be distinct. singularName: type: string description: Singular name of each item. slug: type: string description: Part of a URL that identifier fields: type: array description: An array of custom fields to add to the collection items: description: Details about the field of a collection examples: StaticField: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here OptionField: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight ReferenceField: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 oneOf: - type: object x-fern-type-name: Static Field title: Static Field required: - type - displayName properties: id: type: string format: objectid description: Unique identifier for a Field example: 562ac0395358780a1f5e6fbd readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true example: true isRequired: type: boolean description: define whether a field is required in a collection type: type: string enum: - Color - DateTime - Email - File - Image - Link - MultiImage - Number - Phone - PlainText - RichText - Switch - VideoLink description: Choose these appropriate field type for your collection data displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field example: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here - type: object x-fern-type-name: Option Field title: Option Field required: - type - displayName - metadata properties: id: type: string format: objectid description: Unique identifier for a Field readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true isRequired: type: boolean description: define whether a field is required in a collection type: description: The [Option field type](/data/reference/field-types-item-values#option) type: string enum: - Option displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field metadata: type: object required: - options description: The metadata for the Option field. properties: options: type: array description: The option values for the Option field. items: type: object required: - name description: A single option value for the Option field. properties: name: type: string description: The name of the option id: type: string description: The unique identifier of the option readOnly: true minItems: 1 maxItems: 100 example: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight - type: object x-fern-type-name: Reference Field title: Reference Field required: - type - displayName - metadata properties: id: type: string format: objectid description: Unique identifier for a Field readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true isRequired: type: boolean description: define whether a field is required in a collection type: type: string enum: - MultiReference - Reference description: Choose these appropriate field type for your collection data displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field metadata: type: object required: - collectionId properties: collectionId: type: string description: The unique identifier of the collection description: The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields. example: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 example: displayName: Blog Posts singularName: Blog Post slug: posts fields: - type: PlainText displayName: Title slug: title isRequired: true helpText: The title of the blog post - type: RichText displayName: Content slug: content isRequired: true helpText: The content of the blog post - type: Reference displayName: Author slug: author isRequired: true helpText: The author of the blog post metadata: collectionId: 23cc2d952d4e4631ffd4345d2743db4e responses: '200': description: Request was successful content: application/json: schema: example: id: 7f15043107e2fc95644e93807ee25dd6 displayName: Guide Entries singularName: Guide Entry fields: - id: 5e2a1b3c4d5e6f7890a1b2c3 isEditable: true isRequired: true type: PlainText slug: name displayName: Entry Title helpText: Name of the entry. validations: null - id: 5e2a1b3c4d5e6f7890a1b2c4 isEditable: true isRequired: true type: PlainText slug: slug displayName: Slug helpText: Slug of the entry. validations: null - id: 6f7e8d9c0b1a2e3d4c5b6a7f isEditable: true isRequired: false type: PlainText slug: summary displayName: Summary helpText: A short summary of the entry. validations: null - id: 1a2b3c4d5e6f7a8b9c0d1e2f isEditable: true isRequired: false type: RichText slug: entry-html displayName: Entry HTML helpText: The HTML content of the entry. validations: null - id: 7e8d9c0b1a2e3d4c5b6a7f8e isEditable: true isRequired: false type: Image slug: illustration-image displayName: Illustration Image helpText: An image of the entry. validations: null - id: 2f3e4d5c6b7a8e9d0c1b2a3f isEditable: true isRequired: false type: VideoLink slug: demonstration-video displayName: Demonstration Video helpText: A video of the entry. validations: null - id: 8e9d0c1b2a3f4e5d6c7b8a9e isEditable: true isRequired: false type: Link slug: more-info-link displayName: More Info Link helpText: A link to more information about the entry. validations: null - id: 3f4e5d6c7b8a9e0d1c2b3a4f isEditable: true isRequired: false type: Number slug: importance-level displayName: Importance Level helpText: The importance level of the entry. validations: format: integer allowNegative: false allowZero: false minValue: 1 maxValue: 5 - id: 9e0d1c2b3a4f5e6d7c8b9a0e isEditable: true isRequired: false type: Switch slug: is-essential displayName: Is Essential helpText: Is this entry essential? validations: null - id: 4f5e6d7c8b9a0e1d2c3b4a5f isEditable: true isRequired: false type: Date slug: first-mentioned displayName: First Mentioned helpText: Date of the first mention of the subject. validations: null - id: 0e1d2c3b4a5f6e7d8c9b0a1e isEditable: true isRequired: false type: Color slug: towel-color displayName: Towel Color helpText: The color of the towel. validations: null - id: 5f6e7d8c9b0a1e2d3c4b5a6f isEditable: true isRequired: false type: Reference slug: related-entry displayName: Related Entry helpText: A related entry. validations: collectionId: 7f15043107e2fc95644e93807ee25dd6 - id: 1e2d3c4b5a6f7e8d9c0b1a2f isEditable: true isRequired: false type: MultiReference slug: mentioned-in-entries displayName: Mentioned In Entries helpText: Entries that mention this subject. validations: collectionId: 7f15043107e2fc95644e93807ee25dd6 - id: 6f7e8d9c0b1a2e3d4c5b6a8f isEditable: true isRequired: false type: Option slug: item-type displayName: Item Type helpText: The type of item. validations: options: - name: Survival Gear id: 66f6e966c9e1dc700a857ca3 - name: Gadget id: 66f6e966c9e1dc700a857ca4 - name: Other id: 66f6e966c9e1dc700a857ca5 - id: 2e3d4c5b6a7f8e9d0c1b2a4f isEditable: true isRequired: false type: File slug: guide-file displayName: Guide File helpText: null validations: null - id: 7f8e9d0c1b2a3f4e5d6c8b9e isEditable: true isRequired: false type: Email slug: contributor-email displayName: Contributor Email helpText: null validations: null - id: 3a4f5e6d7c8b9a0e1d2c4b5f isEditable: true isRequired: false type: Phone slug: emergency-contact displayName: Emergency Contact helpText: null validations: null slug: guide-entry createdOn: '2024-04-12T12:42:00.000Z' lastUpdated: '2024-04-12T12:42:00.000Z' description: A collection object type: object required: - id - displayName - singularName - fields properties: id: type: string format: objectid description: Unique identifier for a Collection example: 562ac0395358780a1f5e6fbd displayName: type: string example: Blog Posts description: Name given to the Collection singularName: type: string example: Blog Post description: The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) slug: type: string example: blog-posts description: Slug of Collection in Site URL structure createdOn: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true description: The date the collection was created lastUpdated: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true description: The date the collection was last updated fields: type: array description: The list of fields in the Collection items: description: The details of a field in a collection example: id: 75821f618da60c18383330bcc0ca488b isEditable: true isRequired: false type: RichText slug: post-body displayName: Post Body helpText: Add the body of your post here validations: maxLength: 1000 minLength: 100 type: object required: - id - type - isRequired - displayName properties: id: type: string format: objectid description: Unique identifier for a Field isRequired: type: boolean description: define whether a field is required in a collection isEditable: type: boolean description: Define whether the field is editable readOnly: true type: type: string enum: - Color - DateTime - Email - ExtFileRef - File - Image - Link - MultiImage - MultiReference - Number - Option - Phone - PlainText - Reference - RichText - Switch - VideoLink description: Choose these appropriate field type for your collection data slug: type: string description: Slug of Field in Site URL structure. Slugs should be all lowercase with no spaces. Any spaces will be converted to "-." displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field validations: type: object nullable: true readOnly: true description: The validations for the field properties: additionalProperties: oneOf: - type: string - type: number - type: boolean - type: integer - type: object properties: additionalProperties: true example: displayName: Blog Posts singularName: Blog Post slug: posts createdOn: '2016-10-24T19:41:48Z' lastUpdated: '2016-10-24T19:42:38Z' fields: - type: PlainText displayName: Title slug: title isRequired: true helpText: The title of the blog post - type: RichText displayName: Content slug: content isRequired: true helpText: The content of the blog post - type: Reference displayName: Author slug: author isRequired: true helpText: The author of the blog post metadata: collectionId: 23cc2d952d4e4631ffd4345d2743db4e '400': description: Validation failure x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: validation_error message: 'Validation Error: Provided ID is invalid' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: Collection already exists x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: duplicate_collection message: Collection already exists externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}: get: x-fern-sdk-group-name: collections x-fern-sdk-method-name: get security: - OAuth2: - cms:read operationId: collection-details summary: Webflow Get Collection Details description: 'Get the full details of a collection from its ID. Required scope | `cms:read` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid responses: '200': description: Request was successful content: application/json: schema: example: id: 7f15043107e2fc95644e93807ee25dd6 displayName: Guide Entries singularName: Guide Entry fields: - id: 5e2a1b3c4d5e6f7890a1b2c3 isEditable: true isRequired: true type: PlainText slug: name displayName: Entry Title helpText: Name of the entry. validations: null - id: 5e2a1b3c4d5e6f7890a1b2c4 isEditable: true isRequired: true type: PlainText slug: slug displayName: Slug helpText: Slug of the entry. validations: null - id: 6f7e8d9c0b1a2e3d4c5b6a7f isEditable: true isRequired: false type: PlainText slug: summary displayName: Summary helpText: A short summary of the entry. validations: null - id: 1a2b3c4d5e6f7a8b9c0d1e2f isEditable: true isRequired: false type: RichText slug: entry-html displayName: Entry HTML helpText: The HTML content of the entry. validations: null - id: 7e8d9c0b1a2e3d4c5b6a7f8e isEditable: true isRequired: false type: Image slug: illustration-image displayName: Illustration Image helpText: An image of the entry. validations: null - id: 2f3e4d5c6b7a8e9d0c1b2a3f isEditable: true isRequired: false type: VideoLink slug: demonstration-video displayName: Demonstration Video helpText: A video of the entry. validations: null - id: 8e9d0c1b2a3f4e5d6c7b8a9e isEditable: true isRequired: false type: Link slug: more-info-link displayName: More Info Link helpText: A link to more information about the entry. validations: null - id: 3f4e5d6c7b8a9e0d1c2b3a4f isEditable: true isRequired: false type: Number slug: importance-level displayName: Importance Level helpText: The importance level of the entry. validations: format: integer allowNegative: false allowZero: false minValue: 1 maxValue: 5 - id: 9e0d1c2b3a4f5e6d7c8b9a0e isEditable: true isRequired: false type: Switch slug: is-essential displayName: Is Essential helpText: Is this entry essential? validations: null - id: 4f5e6d7c8b9a0e1d2c3b4a5f isEditable: true isRequired: false type: Date slug: first-mentioned displayName: First Mentioned helpText: Date of the first mention of the subject. validations: null - id: 0e1d2c3b4a5f6e7d8c9b0a1e isEditable: true isRequired: false type: Color slug: towel-color displayName: Towel Color helpText: The color of the towel. validations: null - id: 5f6e7d8c9b0a1e2d3c4b5a6f isEditable: true isRequired: false type: Reference slug: related-entry displayName: Related Entry helpText: A related entry. validations: collectionId: 7f15043107e2fc95644e93807ee25dd6 - id: 1e2d3c4b5a6f7e8d9c0b1a2f isEditable: true isRequired: false type: MultiReference slug: mentioned-in-entries displayName: Mentioned In Entries helpText: Entries that mention this subject. validations: collectionId: 7f15043107e2fc95644e93807ee25dd6 - id: 6f7e8d9c0b1a2e3d4c5b6a8f isEditable: true isRequired: false type: Option slug: item-type displayName: Item Type helpText: The type of item. validations: options: - name: Survival Gear id: 66f6e966c9e1dc700a857ca3 - name: Gadget id: 66f6e966c9e1dc700a857ca4 - name: Other id: 66f6e966c9e1dc700a857ca5 - id: 2e3d4c5b6a7f8e9d0c1b2a4f isEditable: true isRequired: false type: File slug: guide-file displayName: Guide File helpText: null validations: null - id: 7f8e9d0c1b2a3f4e5d6c8b9e isEditable: true isRequired: false type: Email slug: contributor-email displayName: Contributor Email helpText: null validations: null - id: 3a4f5e6d7c8b9a0e1d2c4b5f isEditable: true isRequired: false type: Phone slug: emergency-contact displayName: Emergency Contact helpText: null validations: null slug: guide-entry createdOn: '2024-04-12T12:42:00.000Z' lastUpdated: '2024-04-12T12:42:00.000Z' description: A collection object type: object required: - id - displayName - singularName - fields properties: id: type: string format: objectid description: Unique identifier for a Collection example: 562ac0395358780a1f5e6fbd displayName: type: string example: Blog Posts description: Name given to the Collection singularName: type: string example: Blog Post description: The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) slug: type: string example: blog-posts description: Slug of Collection in Site URL structure createdOn: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true description: The date the collection was created lastUpdated: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true description: The date the collection was last updated fields: type: array description: The list of fields in the Collection items: description: The details of a field in a collection example: id: 75821f618da60c18383330bcc0ca488b isEditable: true isRequired: false type: RichText slug: post-body displayName: Post Body helpText: Add the body of your post here validations: maxLength: 1000 minLength: 100 type: object required: - id - type - isRequired - displayName properties: id: type: string format: objectid description: Unique identifier for a Field isRequired: type: boolean description: define whether a field is required in a collection isEditable: type: boolean description: Define whether the field is editable readOnly: true type: type: string enum: - Color - DateTime - Email - ExtFileRef - File - Image - Link - MultiImage - MultiReference - Number - Option - Phone - PlainText - Reference - RichText - Switch - VideoLink description: Choose these appropriate field type for your collection data slug: type: string description: Slug of Field in Site URL structure. Slugs should be all lowercase with no spaces. Any spaces will be converted to "-." displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field validations: type: object nullable: true readOnly: true description: The validations for the field properties: additionalProperties: oneOf: - type: string - type: number - type: boolean - type: integer - type: object properties: additionalProperties: true '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: collections x-fern-sdk-method-name: delete security: - OAuth2: - cms:write operationId: delete-collection summary: Webflow Delete Collection description: 'Delete a collection using its ID. Required scope | `cms:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid responses: '204': description: Request was successful. No Content is returned. '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/fields: post: x-fern-sdk-group-name: - collections - fields x-fern-sdk-method-name: create security: - OAuth2: - cms:write operationId: create-field summary: Webflow Create Collection Field description: '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` ' tags: - Sites requestBody: description: The field to create required: true content: application/json: schema: description: Details about the field of a collection examples: StaticField: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here OptionField: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight ReferenceField: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 oneOf: - type: object x-fern-type-name: Static Field title: Static Field required: - type - displayName properties: id: type: string format: objectid description: Unique identifier for a Field example: 562ac0395358780a1f5e6fbd readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true example: true isRequired: type: boolean description: define whether a field is required in a collection type: type: string enum: - Color - DateTime - Email - File - Image - Link - MultiImage - Number - Phone - PlainText - RichText - Switch - VideoLink description: Choose these appropriate field type for your collection data displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field example: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here - type: object x-fern-type-name: Option Field title: Option Field required: - type - displayName - metadata properties: id: type: string format: objectid description: Unique identifier for a Field readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true isRequired: type: boolean description: define whether a field is required in a collection type: description: The [Option field type](/data/reference/field-types-item-values#option) type: string enum: - Option displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field metadata: type: object required: - options description: The metadata for the Option field. properties: options: type: array description: The option values for the Option field. items: type: object required: - name description: A single option value for the Option field. properties: name: type: string description: The name of the option id: type: string description: The unique identifier of the option readOnly: true minItems: 1 maxItems: 100 example: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight - type: object x-fern-type-name: Reference Field title: Reference Field required: - type - displayName - metadata properties: id: type: string format: objectid description: Unique identifier for a Field readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true isRequired: type: boolean description: define whether a field is required in a collection type: type: string enum: - MultiReference - Reference description: Choose these appropriate field type for your collection data displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field metadata: type: object required: - collectionId properties: collectionId: type: string description: The unique identifier of the collection description: The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields. example: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 examples: StaticField: value: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here OptionField: value: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight ReferenceField: value: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid responses: '200': description: Request was successful content: application/json: schema: description: Details about the field of a collection examples: StaticField: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here OptionField: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight ReferenceField: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 oneOf: - type: object x-fern-type-name: Static Field title: Static Field required: - type - displayName properties: id: type: string format: objectid description: Unique identifier for a Field example: 562ac0395358780a1f5e6fbd readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true example: true isRequired: type: boolean description: define whether a field is required in a collection type: type: string enum: - Color - DateTime - Email - File - Image - Link - MultiImage - Number - Phone - PlainText - RichText - Switch - VideoLink description: Choose these appropriate field type for your collection data displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field example: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here - type: object x-fern-type-name: Option Field title: Option Field required: - type - displayName - metadata properties: id: type: string format: objectid description: Unique identifier for a Field readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true isRequired: type: boolean description: define whether a field is required in a collection type: description: The [Option field type](/data/reference/field-types-item-values#option) type: string enum: - Option displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field metadata: type: object required: - options description: The metadata for the Option field. properties: options: type: array description: The option values for the Option field. items: type: object required: - name description: A single option value for the Option field. properties: name: type: string description: The name of the option id: type: string description: The unique identifier of the option readOnly: true minItems: 1 maxItems: 100 example: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight - type: object x-fern-type-name: Reference Field title: Reference Field required: - type - displayName - metadata properties: id: type: string format: objectid description: Unique identifier for a Field readOnly: true isEditable: type: boolean description: Define whether the field is editable readOnly: true isRequired: type: boolean description: define whether a field is required in a collection type: type: string enum: - MultiReference - Reference description: Choose these appropriate field type for your collection data displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field metadata: type: object required: - collectionId properties: collectionId: type: string description: The unique identifier of the collection description: The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields. example: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 examples: StaticField: value: id: 562ac0395358780a1f5e6fbc isEditable: true type: RichText isRequired: false displayName: Post Body helpText: Add the body of your post here OptionField: value: id: 562ac0395358780a1f5e6fbc isEditable: true type: Option isRequired: false displayName: Post Type helpText: Add the body of your post here metadata: options: - name: Feature - name: News - name: Product Highlight ReferenceField: value: id: 562ac0395358780a1f5e6fbd isEditable: true type: Reference isRequired: false displayName: Author helpText: Add the post author here metadata: collectionId: 63692ab61fb2852f582ba8f5 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: Collection already exists x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: duplicate_collection message: Collection already exists externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/fields/{field_id}: patch: x-fern-sdk-group-name: - collections - fields x-fern-sdk-method-name: update security: - OAuth2: - cms:write operationId: update-field summary: Webflow Update Collection Field description: 'Update a custom field in a collection. Required scope | `cms:write` ' tags: - Sites requestBody: description: The field details to update content: application/json: schema: description: Details about the field of a collection example: isRequired: false displayName: Post Body helpText: Add the body of your post here type: object properties: isRequired: type: boolean description: Define whether a field is required in a collection displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: field_id in: path description: Unique identifier for a Field in a collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid responses: '200': description: Request was successful content: application/json: schema: description: The details of a field in a collection example: id: 75821f618da60c18383330bcc0ca488b isEditable: true isRequired: false type: RichText slug: post-body displayName: Post Body helpText: Add the body of your post here validations: maxLength: 1000 minLength: 100 type: object required: - id - type - isRequired - displayName properties: id: type: string format: objectid description: Unique identifier for a Field isRequired: type: boolean description: define whether a field is required in a collection isEditable: type: boolean description: Define whether the field is editable readOnly: true type: type: string enum: - Color - DateTime - Email - ExtFileRef - File - Image - Link - MultiImage - MultiReference - Number - Option - Phone - PlainText - Reference - RichText - Switch - VideoLink description: Choose these appropriate field type for your collection data slug: type: string description: Slug of Field in Site URL structure. Slugs should be all lowercase with no spaces. Any spaces will be converted to "-." displayName: type: string description: The name of a field helpText: type: string description: Additional text to help anyone filling out this field validations: type: object nullable: true readOnly: true description: The validations for the field properties: additionalProperties: oneOf: - type: string - type: number - type: boolean - type: integer - type: object properties: additionalProperties: true '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - collections - fields x-fern-sdk-method-name: delete security: - OAuth2: - cms:write operationId: delete-field summary: Webflow Delete Collection Field description: 'Delete a custom field in a collection. This endpoint does not currently support bulk deletion. Required scope | `cms:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: field_id in: path description: Unique identifier for a Field in a collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid responses: '204': description: Request was successful. No Content is returned. '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/comments: get: x-fern-sdk-group-name: - sites - comments x-fern-sdk-method-name: list-comment-threads security: - OAuth2: - comments:read operationId: list-comment-threads summary: Webflow List Comment Threads description: "List all comment threads for a site.\n\n\n There may be a delay of up to 5 minutes before new comments appear in the system.\n\n\nRequired scope | `comments:read`\n" tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null - name: localeId in: query allowEmptyValue: true example: 65427cf400e02b306eaa04a0 description: 'Unique identifier for a specific Locale. [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) ' schema: type: string - in: query example: 0 allowEmptyValue: true name: offset description: Offset used for pagination if the results have more than limit records required: false schema: type: integer - in: query allowEmptyValue: true name: limit example: 100 description: 'Maximum number of records to be returned (max limit: 100)' required: false schema: type: integer - name: sortBy in: query allowEmptyValue: true description: Sort results by the provided value. Only allowed when sortOrder is provided. required: false schema: type: string enum: - createdOn - lastUpdated - name: sortOrder in: query allowEmptyValue: true description: Sorts the results by asc or desc required: false schema: type: string enum: - asc - desc responses: '200': description: Request was successful content: application/json: schema: description: 'A list of comment threads on the site. Contains the content of the first reply. ' required: - comments - pagination properties: comments: type: array items: description: 'A comment thread represents a conversation between users on a specific page. Each comment thread has a unique identifier and can contain multiple comments. Retrieve comment replies using the replies API endpoint. ' type: object required: - id - siteId - pageId - localeId - itemId - breakpoint - url - content - isResolved - author - mentionedUsers - createdOn - lastUpdated properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the comment thread siteId: type: string example: 580e64008c9a982ac9b8b754 description: The site unique identifier pageId: type: string example: 580e64008c9a982ac9b8b754 description: The page unique identifier localeId: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: The locale unique identifier nullable: true itemId: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: The item unique identifier nullable: true breakpoint: type: string example: main description: The breakpoint the comment was left on url: type: string example: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc description: The URL of the page the comment was left on content: type: string example: This is a comment reply description: The content of the comment reply isResolved: type: boolean default: false description: Boolean determining if the comment thread is resolved author: type: object required: - userId - email - name properties: userId: type: string description: The unique identifier of the author email: type: string description: Email of the author name: type: string description: Name of the author example: id: 6287ec36a841b25637c663df email: email name: name mentionedUsers: type: array description: List of mentioned users. This is an empty array until email notifications are sent, which can take up to 5 minutes after the comment is created. items: type: object required: - userId - email - name properties: userId: type: string description: The unique identifier of the mentioned user email: type: string description: Email of the user name: type: string description: Name of the User example: userId: 6287ec36a841b25637c663df email: arthur.dent@heartofgold.spaceship name: Arthur Dent createdOn: type: string format: date-string example: '2023-03-17T18:47:35.560Z' description: The date the item was created lastUpdated: type: string format: date-string example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated example: value: id: 679d2ddb5196117ad04d1ffa siteId: 679826b3b20b045e176bc4b5 pageId: 679826b3b20b045e176bc4bc localeId: 67993753d910db250db64b3e itemId: null breakpoint: main url: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc content: 'This comment mentions another user [[6287ec36a841b25637c663df]] ' isResolved: false author: userId: 6287ec36a841b25637c663df email: ford.prefect@heartofgold.spaceship name: Ford Prefect mentionedUsers: - userId: 6287ec36a841b25637c663df email: arthur.dent@heartofgold.spaceship name: Arthur Dent createdOn: '2025-01-31T20:08:59.759Z' lastUpdated: '2025-01-31T20:08:59.759Z' pagination: type: object required: - limit - offset - total properties: limit: type: integer default: 100 description: The limit specified in the request (default 100) offset: type: integer default: 0 description: The offset specified for pagination total: type: integer description: Total number of comment threads example: comments: - id: 679d2ddb5196117ad04d1ffa siteId: 679826b3b20b045e176bc4b5 pageId: 679826b3b20b045e176bc4bc localeId: 67993753d910db250db64b3e itemId: null breakpoint: main url: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc content: 'Let''s go to the pub! [[6287ec36a841b25637c663df]] ' isResolved: false author: userId: 6287ec36a841b25637c663df email: ford.prefect@heartofgold.spaceship name: Ford Prefect mentionedUsers: - userId: 6287ec36a841b25637c663df email: arthur.dent@heartofgold.spaceship name: Arthur Dent createdOn: '2025-01-31T20:08:59.759Z' lastUpdated: '2025-01-31T20:08:59.759Z' - id: 679d2ddb5196117ad04d1ffc siteId: 679826b3b20b045e176bc4b5 pageId: 679826b3b20b045e176bc4bc localeId: 67993753d910db250db64b3e itemId: null breakpoint: main url: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc content: 'You have five minutes left to drink it [[6287ec36a841b25637c663df]] ' isResolved: false author: userId: 6287ec36a841b25637c663df email: ford.prefect@heartofgold.spaceship name: Ford Prefect mentionedUsers: - userId: 6287ec36a841b25637c663df email: arthur.dent@heartofgold.spaceship name: Arthur Dent createdOn: '2025-01-31T20:08:59.759Z' lastUpdated: '2025-01-31T20:08:59.759Z' pagination: limit: 2 offset: 0 total: 2 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/comments/{comment_thread_id}: get: x-fern-sdk-group-name: - sites - comments x-fern-sdk-method-name: get-comment-thread security: - OAuth2: - comments:read operationId: get-comment-thread summary: Webflow Get Comment Thread description: "Get details of a specific comment thread.\n\n \n There may be a delay of up to 5 minutes before new comments appear in the system.\n \n\nRequired scope | `comments:read`\n" tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null - name: comment_thread_id in: path description: Unique identifier for a Comment Thread example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid - name: localeId in: query allowEmptyValue: true example: 65427cf400e02b306eaa04a0 description: 'Unique identifier for a specific Locale. [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) ' schema: type: string - in: query example: 0 allowEmptyValue: true name: offset description: Offset used for pagination if the results have more than limit records required: false schema: type: integer - in: query allowEmptyValue: true name: limit example: 100 description: 'Maximum number of records to be returned (max limit: 100)' required: false schema: type: integer - name: sortBy in: query allowEmptyValue: true description: Sort results by the provided value. Only allowed when sortOrder is provided. required: false schema: type: string enum: - createdOn - lastUpdated - name: sortOrder in: query allowEmptyValue: true description: Sorts the results by asc or desc required: false schema: type: string enum: - asc - desc responses: '200': description: Request was successful content: application/json: schema: description: 'A comment thread represents a conversation between users on a specific page. Each comment thread has a unique identifier and can contain multiple comments. Retrieve comment replies using the replies API endpoint. ' type: object required: - id - siteId - pageId - localeId - itemId - breakpoint - url - content - isResolved - author - mentionedUsers - createdOn - lastUpdated properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the comment thread siteId: type: string example: 580e64008c9a982ac9b8b754 description: The site unique identifier pageId: type: string example: 580e64008c9a982ac9b8b754 description: The page unique identifier localeId: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: The locale unique identifier nullable: true itemId: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: The item unique identifier nullable: true breakpoint: type: string example: main description: The breakpoint the comment was left on url: type: string example: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc description: The URL of the page the comment was left on content: type: string example: This is a comment reply description: The content of the comment reply isResolved: type: boolean default: false description: Boolean determining if the comment thread is resolved author: type: object required: - userId - email - name properties: userId: type: string description: The unique identifier of the author email: type: string description: Email of the author name: type: string description: Name of the author example: id: 6287ec36a841b25637c663df email: email name: name mentionedUsers: type: array description: List of mentioned users. This is an empty array until email notifications are sent, which can take up to 5 minutes after the comment is created. items: type: object required: - userId - email - name properties: userId: type: string description: The unique identifier of the mentioned user email: type: string description: Email of the user name: type: string description: Name of the User example: userId: 6287ec36a841b25637c663df email: arthur.dent@heartofgold.spaceship name: Arthur Dent createdOn: type: string format: date-string example: '2023-03-17T18:47:35.560Z' description: The date the item was created lastUpdated: type: string format: date-string example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated example: value: id: 679d2ddb5196117ad04d1ffa siteId: 679826b3b20b045e176bc4b5 pageId: 679826b3b20b045e176bc4bc localeId: 67993753d910db250db64b3e itemId: null breakpoint: main url: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc content: 'This comment mentions another user [[6287ec36a841b25637c663df]] ' isResolved: false author: userId: 6287ec36a841b25637c663df email: ford.prefect@heartofgold.spaceship name: Ford Prefect mentionedUsers: - userId: 6287ec36a841b25637c663df email: arthur.dent@heartofgold.spaceship name: Arthur Dent createdOn: '2025-01-31T20:08:59.759Z' lastUpdated: '2025-01-31T20:08:59.759Z' '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/comments/{comment_thread_id}/replies: get: x-fern-sdk-group-name: - sites - comments x-fern-sdk-method-name: list-comment-replies security: - OAuth2: - comments:read operationId: list-comment-replies summary: Webflow List Comment Replies description: "List all replies to a specific comment thread.\n\n\n There may be a delay of up to 5 minutes before new comments appear in the system.\n\n\nRequired scope | `comments:read`\n" tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null - name: comment_thread_id in: path description: Unique identifier for a Comment Thread example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid - name: localeId in: query allowEmptyValue: true example: 65427cf400e02b306eaa04a0 description: 'Unique identifier for a specific Locale. [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) ' schema: type: string - in: query example: 0 allowEmptyValue: true name: offset description: Offset used for pagination if the results have more than limit records required: false schema: type: integer - in: query allowEmptyValue: true name: limit example: 100 description: 'Maximum number of records to be returned (max limit: 100)' required: false schema: type: integer - name: sortBy in: query allowEmptyValue: true description: Sort results by the provided value. Only allowed when sortOrder is provided. required: false schema: type: string enum: - createdOn - lastUpdated - name: sortOrder in: query allowEmptyValue: true description: Sorts the results by asc or desc required: false schema: type: string enum: - asc - desc responses: '200': description: Request was successful content: application/json: schema: description: 'A list of comment replies. ' required: - comments - pagination properties: comments: type: array items: description: 'A comment thread represents a conversation between users on a specific page. Each comment thread has a unique identifier and can contain multiple comments. ' type: object required: - id - commentId - siteId - pageId - breakpoint - content - isResolved - author - lastUpdated - createdOn properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the comment thread commentId: type: string example: 679d2ddb5196117ad04d1ff8 description: The comment reply unique identifier siteId: type: string example: 580e64008c9a982ac9b8b754 description: The site unique identifier pageId: type: string example: 580e64008c9a982ac9b8b754 description: The page unique identifier localeId: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: The locale unique identifier breakpoint: type: string example: main description: The breakpoint the comment was left on content: type: string example: This is a comment reply description: The content of the comment reply isResolved: type: boolean default: false description: Boolean determining if the comment thread is resolved author: type: object required: - id - email - name properties: id: type: string description: The unique identifier of the author email: type: string description: Email of the author name: type: string description: Name of the author example: id: 6287ec36a841b25637c663df email: email name: name mentionedUsers: type: array description: List of mentioned users is an empty array until email notifications are sent. items: type: object required: - id - email - name properties: id: type: string description: The unique identifier of the mentioned user email: type: string description: Email of the user name: type: string description: Name of the User example: id: 6287ec36a841b25637c663df email: arthur.dent@example.com name: Arthur Dent lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created pagination: type: object required: - limit - offset - total properties: limit: type: integer default: 100 description: The limit specified in the request (default 100) offset: type: integer default: 0 description: The offset specified for pagination total: type: integer description: Total number of comment replies example: comments: - id: 679d2ddb5196117ad04d1ffa commentId: 679d2ddb5196117ad04d1ff8 siteId: 679826b3b20b045e176bc4b5 pageId: 679826b3b20b045e176bc4bc localeId: 67993753d910db250db64b3e itemId: null breakpoint: main url: https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc content: 'This comment mentions another user [[6287ec36a841b25637c663df]] ' isResolved: false author: userId: 6287ec36a841b25637c663df email: email name: name mentionedUsers: - userId: 6287ec36a841b25637c663df email: arthur.dent@example.com name: Arthur Dent createdOn: '2025-01-31T20:08:59.759Z' lastUpdated: '2025-01-31T20:08:59.759Z' pagination: limit: 2 offset: 0 total: 1 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /pages/{page_id}/custom_code: get: x-fern-sdk-group-name: - pages - scripts x-fern-sdk-method-name: get-custom-code security: - OAuth2: - custom_code:read operationId: get-page-custom-code summary: Webflow Get Custom Code description: 'Get all scripts applied to a page. Required scope | `custom_code:read` ' tags: - Sites parameters: - name: page_id in: path description: Unique identifier for a Page example: 63c720f9347c2139b248e552 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object properties: scripts: type: array description: A list of scripts applied to a Site or a Page items: type: object required: - id - version - location properties: id: description: ID of the registered custom code script type: string format: objectId location: description: Location of the script, either in the header or footer of the published site type: string default: header enum: - header - footer version: type: string description: Semantic Version String for the registered script *e.g. 0.0.1* attributes: type: object description: Developer-specified key/value pairs to be applied as attributes to the script example: - id: cms_slider - location: header - version: 1.0.0 lastUpdated: type: string format: date-string readOnly: true description: Date when the Site's scripts were last updated createdOn: type: string format: date-string readOnly: true description: Date when the Site's scripts were created example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 example: value: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 attributes: {} lastUpdated: '2022-10-26T00:28:54.191Z' createdOn: '2022-10-26T00:28:54.191Z' '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - pages - scripts x-fern-sdk-method-name: delete-custom-code security: - OAuth2: - custom_code:write operationId: delete-page-custom-code summary: Webflow Delete Custom Code description: '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. Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). Required scope | `custom_code:write` ' tags: - Sites parameters: - name: page_id in: path description: Unique identifier for a Page example: 63c720f9347c2139b248e552 required: true schema: type: string format: objectid default: null responses: '204': description: Request was successful. No Content is returned. '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] put: x-fern-sdk-group-name: - pages - scripts x-fern-sdk-method-name: upsert-custom-code security: - OAuth2: - custom_code:write operationId: add-custom-code-to-page summary: Webflow Add/Update Custom Code description: "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.\n\n\n 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.\n\n\nRequired scope | `custom_code:write`\n" tags: - Sites parameters: - name: page_id in: path description: Unique identifier for a Page example: 63c720f9347c2139b248e552 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object properties: scripts: type: array description: A list of scripts applied to a Site or a Page items: type: object required: - id - version - location properties: id: description: ID of the registered custom code script type: string format: objectId location: description: Location of the script, either in the header or footer of the published site type: string default: header enum: - header - footer version: type: string description: Semantic Version String for the registered script *e.g. 0.0.1* attributes: type: object description: Developer-specified key/value pairs to be applied as attributes to the script example: - id: cms_slider - location: header - version: 1.0.0 lastUpdated: type: string format: date-string readOnly: true description: Date when the Site's scripts were last updated createdOn: type: string format: date-string readOnly: true description: Date when the Site's scripts were created example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 responses: '200': description: Request was successful content: application/json: schema: type: object properties: scripts: type: array description: A list of scripts applied to a Site or a Page items: type: object required: - id - version - location properties: id: description: ID of the registered custom code script type: string format: objectId location: description: Location of the script, either in the header or footer of the published site type: string default: header enum: - header - footer version: type: string description: Semantic Version String for the registered script *e.g. 0.0.1* attributes: type: object description: Developer-specified key/value pairs to be applied as attributes to the script example: - id: cms_slider - location: header - version: 1.0.0 lastUpdated: type: string format: date-string readOnly: true description: Date when the Site's scripts were last updated createdOn: type: string format: date-string readOnly: true description: Date when the Site's scripts were created example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 attributes: {} lastUpdated: '2022-10-26T00:28:54.191Z' createdOn: '2022-10-26T00:28:54.191Z' '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: The maximum number of registered scripts has been reached. x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: custom_code_max_registered_scripts message: The maximum number of registered scripts has been reached. externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/custom_code: get: x-fern-sdk-group-name: - sites - scripts x-fern-sdk-method-name: get-custom-code security: - OAuth2: - custom_code:read operationId: get-site-custom-code summary: Webflow Get Custom Code description: "Get all scripts applied to a site by the App.\n\n\n 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.\n\n\nRequired scope | `custom_code:read`\n" tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object properties: scripts: type: array description: A list of scripts applied to a Site or a Page items: type: object required: - id - version - location properties: id: description: ID of the registered custom code script type: string format: objectId location: description: Location of the script, either in the header or footer of the published site type: string default: header enum: - header - footer version: type: string description: Semantic Version String for the registered script *e.g. 0.0.1* attributes: type: object description: Developer-specified key/value pairs to be applied as attributes to the script example: - id: cms_slider - location: header - version: 1.0.0 lastUpdated: type: string format: date-string readOnly: true description: Date when the Site's scripts were last updated createdOn: type: string format: date-string readOnly: true description: Date when the Site's scripts were created example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 attributes: {} lastUpdated: '2022-10-26T00:28:54.191Z' createdOn: '2022-10-26T00:28:54.191Z' '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - sites - scripts x-fern-sdk-method-name: delete-custom-code security: - OAuth2: - custom_code:write operationId: delete-site-custom-code summary: Webflow Delete Custom Code description: '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. Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). Required scope | `custom_code:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '204': description: Request was successful. No Content is returned. '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] put: x-fern-sdk-group-name: - sites - scripts x-fern-sdk-method-name: upsert-custom-code security: - OAuth2: - custom_code:write operationId: add-custom-code-tosite summary: Webflow Add/Update Custom Code description: "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.\n\n\n 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.\n\n\nRequired scope | `custom_code:write`\n" tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object properties: scripts: type: array description: A list of scripts applied to a Site or a Page items: type: object required: - id - version - location properties: id: description: ID of the registered custom code script type: string format: objectId location: description: Location of the script, either in the header or footer of the published site type: string default: header enum: - header - footer version: type: string description: Semantic Version String for the registered script *e.g. 0.0.1* attributes: type: object description: Developer-specified key/value pairs to be applied as attributes to the script example: - id: cms_slider - location: header - version: 1.0.0 lastUpdated: type: string format: date-string readOnly: true description: Date when the Site's scripts were last updated createdOn: type: string format: date-string readOnly: true description: Date when the Site's scripts were created example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 responses: '200': description: Request was successful content: application/json: schema: type: object properties: scripts: type: array description: A list of scripts applied to a Site or a Page items: type: object required: - id - version - location properties: id: description: ID of the registered custom code script type: string format: objectId location: description: Location of the script, either in the header or footer of the published site type: string default: header enum: - header - footer version: type: string description: Semantic Version String for the registered script *e.g. 0.0.1* attributes: type: object description: Developer-specified key/value pairs to be applied as attributes to the script example: - id: cms_slider - location: header - version: 1.0.0 lastUpdated: type: string format: date-string readOnly: true description: Date when the Site's scripts were last updated createdOn: type: string format: date-string readOnly: true description: Date when the Site's scripts were created example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 example: scripts: - id: cms_slider location: header version: 1.0.0 attributes: my-attribute: some-value - id: alert location: header version: 0.0.1 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /workspaces/{workspace_id}/sites: post: x-fern-sdk-group-name: sites x-fern-sdk-method-name: create security: - OAuth2: - sites:write operationId: create-site summary: Webflow Create Site description: 'Create a site. This endpoint requires an Enterprise workspace. Required scope | `workspace:write` ' tags: - Sites parameters: - name: workspace_id in: path description: Unique identifier for a Workspace example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: required: - name properties: name: type: string example: The Hitchhiker's Guide to the Galaxy description: The name of the site templateName: type: string example: Megadodo Publications - Guide Template description: The workspace or marketplace template to use parentFolderId: type: string nullable: true example: a9c420f9347c2139b248e913 description: MegaDodo Publications - Potential Book Ideas responses: '201': description: Request was successful content: application/json: schema: required: - id - workspaceId - createdOn - displayName - shortName - templateName - lastPublished - lastUpdated - previewUrl - timeZone - dataCollectionEnabled - dataCollectionType example: id: 42e98c9a982ac9b8b742 workspaceId: 42e63e98c9a982ac9b8b742 displayName: The Hitchhiker's Guide to the Galaxy shortName: hitchhikers-guide previewUrl: https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png timeZone: Magrathea/FactoryFloor createdOn: '1979-10-12T12:00:00.000Z' lastUpdated: '2023-04-02T12:42:00.000Z' lastPublished: '2023-04-02T12:42:00.000Z' parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: - id: 589a331aa51e760df7ccb89d url: hitchhikersguide.galaxy - id: 589a331aa51e760df7ccb89e url: heartofgold.spaceship locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: false displayName: English (United States) displayImageId: null redirect: true subdirectory: '' tag: en-US secondary: - id: 653fd9af6a07fc9cfd7a5e56 cmsLocaleId: 653fd9af6a07fc9cfd7a5e5d enabled: true displayName: French (France) displayImageId: null subdirectory: fr-fr tag: fr-FR - id: 654112a3a525b2739d97664c cmsLocaleId: 654112a3a525b2739d97664f enabled: true displayName: Spanish (Mexico) displayImageId: null subdirectory: es-mx tag: es-MX dataCollectionEnabled: true dataCollectionType: always properties: id: type: string format: objectid description: Unique identifier for the Site example: 580e63e98c9a982ac9b8b741 workspaceId: type: string format: objectid description: Unique identifier for the Workspace example: 580e63e98c9a982ac9b8b741 createdOn: type: string format: date-time description: Date the Site was created example: '2016-10-24T19:41:29.156Z' displayName: type: string description: Name given to Site example: api_docs_sample_json shortName: type: string description: Slugified version of name example: api-docs-sample-json lastPublished: type: string format: date-time description: Date the Site was last published example: '2016-10-24T19:43:17.271Z' lastUpdated: type: string format: date-time description: Date the Site was last updated example: '2016-10-24T19:43:17.271Z' previewUrl: type: string format: uri description: URL of a generated image for the given Site example: https://dev-assets.website-files.com/580e63e98c9a982ac9b8b741/201610241243.png timeZone: type: string description: Site timezone set under Site Settings example: America/Los_Angeles parentFolderId: type: string format: objectid nullable: true description: The ID of the parent folder the Site exists in example: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: type: array items: type: object required: - id properties: id: type: string format: objectid example: 589a331aa51e760df7ccb89d description: Unique identifier for the Domain url: type: string example: test-api-domain.com description: The registered Domain name lastPublished: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true nullable: true description: The date the custom domain was last published to example: id: 589a331aa51e760df7ccb89d url: test-api-domain.com lastPublished: '2022-12-07T16:51:37.571Z' locales: type: object properties: primary: description: The primary locale for the site or application. type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US secondary: type: array items: type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US description: A list of secondary locales available for the site or application. dataCollectionEnabled: type: boolean description: Indicates if data collection is enabled for the site. example: false dataCollectionType: type: string enum: - always - optOut - disabled description: The type of data collection enabled for the site. example: always examples: NewlyCreatedSite: value: id: 670ecf86817e3cc7a510eb6a workspaceId: 625860a7a6c16d624927122f displayName: The Hitchiker's Guide shortName: hitchikers-guide previewUrl: null timeZone: null createdOn: '2024-10-15T20:24:38.134Z' lastUpdated: '2024-10-15T20:24:38.326Z' lastPublished: null parentFolderId: 670ece123598db72d9648be1 customDomains: [] locales: null dataCollectionEnabled: true dataCollectionType: always '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '403': description: Forbidden request content: application/json: schema: oneOf: - description: Provided access token is valid, but is missing the required scopes. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: missing_scopes message: 'OAuthForbidden: You are missing the following scopes - components:write' externalReference: null details: [] - description: Error response for non-enterprise plan workspaces. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_enterprise_plan_workspace message: This workspace is not associated with an Enterprise plan externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites: get: x-fern-sdk-group-name: sites x-fern-sdk-method-name: list security: - OAuth2: - sites:read operationId: list-sites summary: Webflow List Sites description: 'List of all sites the provided access token is able to access. Required scope | `sites:read` ' tags: - Sites responses: '200': description: Request was successful content: application/json: schema: type: object properties: sites: type: array items: example: id: 42e98c9a982ac9b8b742 workspaceId: 42e63e98c9a982ac9b8b742 displayName: The Hitchhiker's Guide to the Galaxy shortName: hitchhikers-guide previewUrl: https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png timeZone: Magrathea/FactoryFloor createdOn: '1979-10-12T12:00:00.000Z' lastUpdated: '2023-04-02T12:42:00.000Z' lastPublished: '2023-04-02T12:42:00.000Z' parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: - id: 589a331aa51e760df7ccb89d url: hitchhikersguide.galaxy - id: 589a331aa51e760df7ccb89e url: heartofgold.spaceship locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: false displayName: English (United States) displayImageId: null redirect: true subdirectory: '' tag: en-US secondary: - id: 653fd9af6a07fc9cfd7a5e56 cmsLocaleId: 653fd9af6a07fc9cfd7a5e5d enabled: true displayName: French (France) displayImageId: null subdirectory: fr-fr tag: fr-FR - id: 654112a3a525b2739d97664c cmsLocaleId: 654112a3a525b2739d97664f enabled: true displayName: Spanish (Mexico) displayImageId: null subdirectory: es-mx tag: es-MX dataCollectionEnabled: true dataCollectionType: always required: - id properties: id: type: string format: objectid description: Unique identifier for the Site example: 580e63e98c9a982ac9b8b741 workspaceId: type: string format: objectid description: Unique identifier for the Workspace example: 580e63e98c9a982ac9b8b741 createdOn: type: string format: date-time description: Date the Site was created example: '2016-10-24T19:41:29.156Z' displayName: type: string description: Name given to Site example: api_docs_sample_json shortName: type: string description: Slugified version of name example: api-docs-sample-json lastPublished: type: string format: date-time description: Date the Site was last published example: '2016-10-24T19:43:17.271Z' lastUpdated: type: string format: date-time description: Date the Site was last updated example: '2016-10-24T19:43:17.271Z' previewUrl: type: string format: uri description: URL of a generated image for the given Site example: https://dev-assets.website-files.com/580e63e98c9a982ac9b8b741/201610241243.png timeZone: type: string description: Site timezone set under Site Settings example: America/Los_Angeles parentFolderId: type: string format: objectid nullable: true description: The ID of the parent folder the Site exists in example: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: type: array items: type: object required: - id properties: id: type: string format: objectid example: 589a331aa51e760df7ccb89d description: Unique identifier for the Domain url: type: string example: test-api-domain.com description: The registered Domain name lastPublished: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true nullable: true description: The date the custom domain was last published to example: id: 589a331aa51e760df7ccb89d url: test-api-domain.com lastPublished: '2022-12-07T16:51:37.571Z' locales: type: object properties: primary: description: The primary locale for the site or application. type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US secondary: type: array items: type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US description: A list of secondary locales available for the site or application. dataCollectionEnabled: type: boolean description: Indicates if data collection is enabled for the site. example: false dataCollectionType: type: string enum: - always - optOut - disabled description: The type of data collection enabled for the site. example: always example: sites: - id: 42e63e98c9a982ac9b8b741 workspaceId: 42e63fc8c9a982ac9b8b744 createdOn: '1979-10-12T12:00:00.000Z' displayName: Heart of Gold Spaceship shortName: heart-of-gold lastPublished: '2023-04-02T12:42:00.000Z' previewUrl: https://dev-assets.website-files.com/42e63e98c9a982ac9b8b741/197910121200.png timeZone: DeepSpace/InfiniteImprobability parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: - id: 589a331aa51e760df7ccb89e url: heartofgold.galaxy lastPublished: '2022-12-07T16:51:37.571Z' locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: true displayName: English - Heart of Gold Standard redirect: false subdirectory: /en tag: The Ultimate Answer secondary: - id: 653fd9af6a07fc9cfd7a5e58 cmsLocaleId: 653ad57de882f528b32e810g enabled: true displayName: Betelgeusian - Vogon Liaison redirect: true subdirectory: /bet tag: Vogon - id: 653fd9af6a07fc9cfd7a5e59 cmsLocaleId: 653ad57de882f528b32e810h enabled: false displayName: Magrathean - Custom Planet Designs redirect: true subdirectory: /mg tag: Magrathean dataCollectionEnabled: true dataCollectionType: always - id: 42e63e98c9a982ac9b8b742 workspaceId: 42e63fc8c9a982ac9b8b745 createdOn: '1981-10-12T12:00:00.000Z' displayName: Marvin's Personal Blog shortName: paranoid-android lastPublished: '2023-04-02T12:45:00.000Z' previewUrl: https://dev-assets.website-files.com/42e63e98c9a982ac9b8b742/198110121200.png timeZone: DeepSpace/Depression parentFolderId: null customDomains: - id: 589a331aa51e760df7ccb89f url: marvin.blog lastPublished: '2022-12-07T16:51:37.571Z' locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: true displayName: English - Marvin's Musings redirect: false subdirectory: /en tag: English secondary: - id: 653fd9af6a07fc9cfd7a5e56 cmsLocaleId: 653ad57de882f528b32e810f enabled: true displayName: Squornshellous - Mattress Speak redirect: true subdirectory: /sr tag: Squornshellous dataCollectionEnabled: true dataCollectionType: always - id: 42e63e98c9a982ac9b8b743 workspaceId: 42e63fc8c9a982ac9b8b746 createdOn: '1982-10-12T12:00:00.000Z' displayName: Vogon Poetry Archive shortName: vogon-poetry lastPublished: '2023-04-02T12:50:00.000Z' previewUrl: https://dev-assets.website-files.com/42e63e98c9a982ac9b8b743/198210121200.png timeZone: Vogsphere/PoetryHall parentFolderId: null customDomains: - id: 589a331aa51e760df7ccb8a0 url: vogonpoetry.galaxy lastPublished: '2022-12-07T16:51:37.571Z' locales: primary: id: 653fd9af6a07fc9cfd7a5e55 cmsLocaleId: 653ad57de882f528b32e810d enabled: true displayName: English - Vogon Verse redirect: false subdirectory: /en tag: Third Worst Poetry secondary: - id: 653fd9af6a07fc9cfd7a5e54 cmsLocaleId: 653ad57de882f528b32e810c enabled: true displayName: Galactic - Universal Language redirect: true subdirectory: /gl tag: Pan-Galactic Gargle Blaster dataCollectionEnabled: true dataCollectionType: always '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] 4XX: description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] 5XX: description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}: get: x-fern-sdk-group-name: sites x-fern-sdk-method-name: get security: - OAuth2: - sites:read operationId: get-site summary: Webflow Get Site description: 'Get details of a site. Required scope | `sites:read` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: example: id: 42e98c9a982ac9b8b742 workspaceId: 42e63e98c9a982ac9b8b742 displayName: The Hitchhiker's Guide to the Galaxy shortName: hitchhikers-guide previewUrl: https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png timeZone: Magrathea/FactoryFloor createdOn: '1979-10-12T12:00:00.000Z' lastUpdated: '2023-04-02T12:42:00.000Z' lastPublished: '2023-04-02T12:42:00.000Z' parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: - id: 589a331aa51e760df7ccb89d url: hitchhikersguide.galaxy - id: 589a331aa51e760df7ccb89e url: heartofgold.spaceship locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: false displayName: English (United States) displayImageId: null redirect: true subdirectory: '' tag: en-US secondary: - id: 653fd9af6a07fc9cfd7a5e56 cmsLocaleId: 653fd9af6a07fc9cfd7a5e5d enabled: true displayName: French (France) displayImageId: null subdirectory: fr-fr tag: fr-FR - id: 654112a3a525b2739d97664c cmsLocaleId: 654112a3a525b2739d97664f enabled: true displayName: Spanish (Mexico) displayImageId: null subdirectory: es-mx tag: es-MX dataCollectionEnabled: true dataCollectionType: always required: - id properties: id: type: string format: objectid description: Unique identifier for the Site example: 580e63e98c9a982ac9b8b741 workspaceId: type: string format: objectid description: Unique identifier for the Workspace example: 580e63e98c9a982ac9b8b741 createdOn: type: string format: date-time description: Date the Site was created example: '2016-10-24T19:41:29.156Z' displayName: type: string description: Name given to Site example: api_docs_sample_json shortName: type: string description: Slugified version of name example: api-docs-sample-json lastPublished: type: string format: date-time description: Date the Site was last published example: '2016-10-24T19:43:17.271Z' lastUpdated: type: string format: date-time description: Date the Site was last updated example: '2016-10-24T19:43:17.271Z' previewUrl: type: string format: uri description: URL of a generated image for the given Site example: https://dev-assets.website-files.com/580e63e98c9a982ac9b8b741/201610241243.png timeZone: type: string description: Site timezone set under Site Settings example: America/Los_Angeles parentFolderId: type: string format: objectid nullable: true description: The ID of the parent folder the Site exists in example: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: type: array items: type: object required: - id properties: id: type: string format: objectid example: 589a331aa51e760df7ccb89d description: Unique identifier for the Domain url: type: string example: test-api-domain.com description: The registered Domain name lastPublished: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true nullable: true description: The date the custom domain was last published to example: id: 589a331aa51e760df7ccb89d url: test-api-domain.com lastPublished: '2022-12-07T16:51:37.571Z' locales: type: object properties: primary: description: The primary locale for the site or application. type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US secondary: type: array items: type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US description: A list of secondary locales available for the site or application. dataCollectionEnabled: type: boolean description: Indicates if data collection is enabled for the site. example: false dataCollectionType: type: string enum: - always - optOut - disabled description: The type of data collection enabled for the site. example: always examples: SiteWithLocales: value: id: 42e98c9a982ac9b8b742 workspaceId: 42e63e98c9a982ac9b8b742 displayName: The Hitchhiker's Guide to the Galaxy shortName: hitchhikers-guide previewUrl: https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png timeZone: Magrathea/FactoryFloor createdOn: '1979-10-12T12:00:00.000Z' lastUpdated: '2023-04-02T12:42:00.000Z' lastPublished: '2023-04-02T12:42:00.000Z' parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: - id: 589a331aa51e760df7ccb89d url: hitchhikersguide.galaxy - id: 589a331aa51e760df7ccb89e url: heartofgold.spaceship locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: false displayName: English (United States) displayImageId: null redirect: true subdirectory: '' tag: en-US secondary: - id: 653fd9af6a07fc9cfd7a5e56 cmsLocaleId: 653fd9af6a07fc9cfd7a5e5d enabled: true displayName: French (France) displayImageId: null subdirectory: fr-fr tag: fr-FR - id: 654112a3a525b2739d97664c cmsLocaleId: 654112a3a525b2739d97664f enabled: true displayName: Spanish (Mexico) displayImageId: null subdirectory: es-mx tag: es-MX dataCollectionEnabled: true dataCollectionType: always '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] patch: x-fern-sdk-group-name: sites x-fern-sdk-method-name: update security: - OAuth2: - sites:write operationId: update-site summary: Webflow Update Site description: 'Update a site. This endpoint requires an Enterprise workspace. Required scope | `sites:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: properties: name: type: string example: Super Cool Site description: The name of the site parentFolderId: type: string nullable: true example: a9c420f9347c2139b248e913 description: The parent folder ID of the site responses: '200': description: Request was successful content: application/json: schema: example: id: 42e98c9a982ac9b8b742 workspaceId: 42e63e98c9a982ac9b8b742 displayName: The Hitchhiker's Guide to the Galaxy shortName: hitchhikers-guide previewUrl: https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png timeZone: Magrathea/FactoryFloor createdOn: '1979-10-12T12:00:00.000Z' lastUpdated: '2023-04-02T12:42:00.000Z' lastPublished: '2023-04-02T12:42:00.000Z' parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: - id: 589a331aa51e760df7ccb89d url: hitchhikersguide.galaxy - id: 589a331aa51e760df7ccb89e url: heartofgold.spaceship locales: primary: id: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: 653ad57de882f528b32e810e enabled: false displayName: English (United States) displayImageId: null redirect: true subdirectory: '' tag: en-US secondary: - id: 653fd9af6a07fc9cfd7a5e56 cmsLocaleId: 653fd9af6a07fc9cfd7a5e5d enabled: true displayName: French (France) displayImageId: null subdirectory: fr-fr tag: fr-FR - id: 654112a3a525b2739d97664c cmsLocaleId: 654112a3a525b2739d97664f enabled: true displayName: Spanish (Mexico) displayImageId: null subdirectory: es-mx tag: es-MX dataCollectionEnabled: true dataCollectionType: always required: - id properties: id: type: string format: objectid description: Unique identifier for the Site example: 580e63e98c9a982ac9b8b741 workspaceId: type: string format: objectid description: Unique identifier for the Workspace example: 580e63e98c9a982ac9b8b741 createdOn: type: string format: date-time description: Date the Site was created example: '2016-10-24T19:41:29.156Z' displayName: type: string description: Name given to Site example: api_docs_sample_json shortName: type: string description: Slugified version of name example: api-docs-sample-json lastPublished: type: string format: date-time description: Date the Site was last published example: '2016-10-24T19:43:17.271Z' lastUpdated: type: string format: date-time description: Date the Site was last updated example: '2016-10-24T19:43:17.271Z' previewUrl: type: string format: uri description: URL of a generated image for the given Site example: https://dev-assets.website-files.com/580e63e98c9a982ac9b8b741/201610241243.png timeZone: type: string description: Site timezone set under Site Settings example: America/Los_Angeles parentFolderId: type: string format: objectid nullable: true description: The ID of the parent folder the Site exists in example: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 customDomains: type: array items: type: object required: - id properties: id: type: string format: objectid example: 589a331aa51e760df7ccb89d description: Unique identifier for the Domain url: type: string example: test-api-domain.com description: The registered Domain name lastPublished: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true nullable: true description: The date the custom domain was last published to example: id: 589a331aa51e760df7ccb89d url: test-api-domain.com lastPublished: '2022-12-07T16:51:37.571Z' locales: type: object properties: primary: description: The primary locale for the site or application. type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US secondary: type: array items: type: object properties: id: type: string description: The unique identifier for the locale. example: 653fd9af6a07fc9cfd7a5e57 cmsLocaleId: type: string description: A CMS-specific identifier for the locale. example: 653ad57de882f528b32e810e enabled: type: boolean description: Indicates if the locale is enabled. example: false displayName: type: string description: The display name of the locale, typically in English. example: English (United States) displayImageId: type: string description: An optional ID for an image associated with the locale, nullable. nullable: true example: null redirect: type: boolean description: Determines if requests should redirect to the locale's subdirectory. example: true subdirectory: type: string description: The subdirectory path for the locale, used in URLs. example: '' tag: type: string description: A tag or code representing the locale, often following a standard format like 'en-US'. example: en-US description: A list of secondary locales available for the site or application. dataCollectionEnabled: type: boolean description: Indicates if data collection is enabled for the site. example: false dataCollectionType: type: string enum: - always - optOut - disabled description: The type of data collection enabled for the site. example: always '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '403': description: Forbidden request content: application/json: schema: oneOf: - description: Provided access token is valid, but is missing the required scopes. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: missing_scopes message: 'OAuthForbidden: You are missing the following scopes - components:write' externalReference: null details: [] - description: Error response for non-enterprise plan sites. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_enterprise_plan_site message: This site is not associated with an Enterprise plan externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: sites x-fern-sdk-method-name: delete security: - OAuth2: - sites:write operationId: delete-site summary: Webflow Delete Site description: 'Delete a site. This endpoint requires an Enterprise workspace. Required scope | `sites:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '204': description: Request was successful. No Content is returned. '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '403': description: Forbidden request content: application/json: schema: oneOf: - description: Provided access token is valid, but is missing the required scopes. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: missing_scopes message: 'OAuthForbidden: You are missing the following scopes - components:write' externalReference: null details: [] - description: Error response for non-enterprise plan sites. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_enterprise_plan_site message: This site is not associated with an Enterprise plan externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/custom_domains: get: x-fern-sdk-group-name: sites x-fern-sdk-method-name: get-custom-domain security: - OAuth2: - sites:read operationId: get-custom-domains summary: Webflow Get Custom Domains description: 'Get a list of all custom domains related to site. Required scope | `sites:read` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object properties: customDomains: type: array items: type: object required: - id properties: id: type: string format: objectid example: 589a331aa51e760df7ccb89d description: Unique identifier for the Domain url: type: string example: test-api-domain.com description: The registered Domain name lastPublished: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true nullable: true description: The date the custom domain was last published to example: id: 589a331aa51e760df7ccb89d url: test-api-domain.com lastPublished: '2022-12-07T16:51:37.571Z' example: customDomains: - id: 589a331aa51e760df7ccb89d url: hitchhikersguide.galaxy lastPublished: '2022-12-07T16:51:37.571Z' - id: 589a331aa51e760df7ccb89e url: heartofgold.spaceship lastPublished: '2022-12-07T16:51:37.571Z' '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '403': description: Forbidden x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: forbidden message: User is not authorized to perform this action externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/publish: post: x-fern-sdk-group-name: sites x-fern-sdk-method-name: publish security: - OAuth2: - sites:write operationId: site-publish summary: Webflow Publish Site description: '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. This endpoint has a specific rate limit of one successful publish queue per minute. Required scope | `sites:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object minProperties: 1 properties: customDomains: description: Array of Custom Domain IDs to publish type: array items: description: The ID of the Custom Domain type: string example: 589a331aa51e760df7ccb89d example: - 660c6449dd97ebc7346ac629 - 660c6449dd97ebc7346ac62f publishToWebflowSubdomain: description: Choice of whether to publish to the default Webflow Subdomain type: boolean default: false example: false examples: DomainIDs: value: customDomains: - 660c6449dd97ebc7346ac629 - 660c6449dd97ebc7346ac62f publishToWebflowSubdomain: false responses: '202': description: Request accepted content: application/json: schema: type: object properties: customDomains: description: Array of domains objects type: array items: type: object required: - id properties: id: type: string format: objectid example: 589a331aa51e760df7ccb89d description: Unique identifier for the Domain url: type: string example: test-api-domain.com description: The registered Domain name lastPublished: type: string format: date-time example: '2022-12-07T16:51:37.571Z' readOnly: true nullable: true description: The date the custom domain was last published to example: id: 589a331aa51e760df7ccb89d url: test-api-domain.com lastPublished: '2022-12-07T16:51:37.571Z' publishToWebflowSubdomain: description: Flag for publishing to webflow.io subdomain type: boolean default: false '400': description: Bad Request content: application/json: schema: oneOf: - description: Requested an invalid Domain. Please send a valid custom domain URI. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: invalid_domain message: Please send a valid custom domain ID externalReference: null details: [] - description: You must pass at least one domain ID to the publish endpoint. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: no_domains message: No domain IDs provided externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '403': description: Forbidden x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: forbidden message: User is not authorized to perform this action externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] /sites/{site_id}/redirects: get: x-fern-sdk-group-name: - sites - redirects x-fern-sdk-method-name: list security: - OAuth2: - sites:read operationId: get-redirects summary: Webflow Get 301 redirects description: '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. This endpoint requires an Enterprise workspace. Required scope: `sites:read` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object description: Site redirects response properties: redirects: type: array description: List of redirects for a given site items: type: object description: A single redirection rule, specifying a source URL and a destination URL. properties: id: type: string description: The ID of the specific redirect rule example: 66c4cb9a20cac35ed19500e6 readOnly: true fromUrl: type: string description: The source URL path that will be redirected. example: /mostly-harmless toUrl: type: string description: The target URL path where the user or client will be redirected. example: /earth example: id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth pagination: description: Pagination object type: object required: - limit - offset - total properties: limit: type: integer description: The limit used for pagination example: 100 readOnly: true offset: type: integer description: The offset used for pagination example: 0 readOnly: true total: type: integer description: The total number of records example: 100 readOnly: true example: redirects: - id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth - id: 6x9e7f8d9a4b1c2d3e4f5678 fromUrl: /babel-fish toUrl: /translate pagination: limit: 100 offset: 0 total: 2 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] post: x-fern-sdk-group-name: - sites - redirects x-fern-sdk-method-name: create security: - OAuth2: - sites:write operationId: create-redirect summary: Webflow Create a 301 redirect description: '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. This endpoint requires an Enterprise workspace. Required scope: `sites:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object description: A single redirection rule, specifying a source URL and a destination URL. properties: id: type: string description: The ID of the specific redirect rule example: 66c4cb9a20cac35ed19500e6 readOnly: true fromUrl: type: string description: The source URL path that will be redirected. example: /mostly-harmless toUrl: type: string description: The target URL path where the user or client will be redirected. example: /earth example: id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth responses: '200': description: Request was successful content: application/json: schema: type: object description: A single redirection rule, specifying a source URL and a destination URL. properties: id: type: string description: The ID of the specific redirect rule example: 66c4cb9a20cac35ed19500e6 readOnly: true fromUrl: type: string description: The source URL path that will be redirected. example: /mostly-harmless toUrl: type: string description: The target URL path where the user or client will be redirected. example: /earth example: id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/redirects/{redirect_id}: patch: x-fern-sdk-group-name: - sites - redirects x-fern-sdk-method-name: update security: - OAuth2: - sites:write operationId: update-redirect summary: Webflow Update 301 redirect description: 'Update a 301 redirection rule from a site. This endpoint requires an Enterprise workspace. Required scope: `sites:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null - name: redirect_id in: path description: Unique identifier site redirect example: 66c4cb9a20cac35ed19500e6 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object description: A single redirection rule, specifying a source URL and a destination URL. properties: id: type: string description: The ID of the specific redirect rule example: 66c4cb9a20cac35ed19500e6 readOnly: true fromUrl: type: string description: The source URL path that will be redirected. example: /mostly-harmless toUrl: type: string description: The target URL path where the user or client will be redirected. example: /earth example: id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth responses: '200': description: Request was successful content: application/json: schema: type: object description: A single redirection rule, specifying a source URL and a destination URL. properties: id: type: string description: The ID of the specific redirect rule example: 66c4cb9a20cac35ed19500e6 readOnly: true fromUrl: type: string description: The source URL path that will be redirected. example: /mostly-harmless toUrl: type: string description: The target URL path where the user or client will be redirected. example: /earth example: id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - sites - redirects x-fern-sdk-method-name: delete security: - OAuth2: - sites:write operationId: delete-redirects summary: Webflow Delete 301 redirects description: '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. This endpoint requires an Enterprise workspace. Required scope: `sites:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null - name: redirect_id in: path description: Unique identifier site redirect example: 66c4cb9a20cac35ed19500e6 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object description: Site redirects response properties: redirects: type: array description: List of redirects for a given site items: type: object description: A single redirection rule, specifying a source URL and a destination URL. properties: id: type: string description: The ID of the specific redirect rule example: 66c4cb9a20cac35ed19500e6 readOnly: true fromUrl: type: string description: The source URL path that will be redirected. example: /mostly-harmless toUrl: type: string description: The target URL path where the user or client will be redirected. example: /earth example: id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth pagination: description: Pagination object type: object required: - limit - offset - total properties: limit: type: integer description: The limit used for pagination example: 100 readOnly: true offset: type: integer description: The offset used for pagination example: 0 readOnly: true total: type: integer description: The total number of records example: 100 readOnly: true example: redirects: - id: 42e1a2b7aa1a13f768a0042a fromUrl: /mostly-harmless toUrl: /earth - id: 6x9e7f8d9a4b1c2d3e4f5678 fromUrl: /babel-fish toUrl: /translate pagination: limit: 100 offset: 0 total: 2 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/plan: get: x-fern-sdk-group-name: - sites - plans x-fern-sdk-method-name: get-site-plan security: - OAuth2: - sites:read operationId: get-site-plan summary: Webflow Get Site Plan description: 'Get site plan details for the specified Site. This endpoint requires an Enterprise workspace. Required scope | `sites:read` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: example: id: hosting-business-v4 name: Business Hosting pricingDetails: https://webflow.com/pricing type: object properties: id: description: ID of the hosting plan. type: string enum: - hosting-basic-v3 - hosting-cms-v3 - hosting-business-v3 - hosting-ecommerce-standard-v2 - hosting-ecommerce-plus-v2 - hosting-ecommerce-advanced-v2 - hosting-basic-v4 - hosting-cms-v4 - hosting-business-v4 - hosting-ecommerce-standard-v3 - hosting-ecommerce-plus-v3 - hosting-ecommerce-advanced-v3 name: description: Name of the hosting plan. type: string enum: - Basic Hosting - CMS Hosting - Business Hosting - ECommerce Standard Hosting - ECommerce Plus Hosting - ECommerce Advanced Hosting pricingInfo: description: URL for more information about Webflow hosting plan pricing. type: string example: https://webflow.com/pricing '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/robots_txt: get: x-fern-sdk-group-name: - sites - robots-txt x-fern-sdk-method-name: get security: - OAuth2: - site_config:read operationId: get-robots-txt summary: Webflow Get robots.txt description: 'Retrieve the robots.txt configuration for various user agents. This endpoint requires an Enterprise workspace. Required scope: `site_config:read` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null responses: '200': description: Request was successful content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] put: x-fern-sdk-group-name: - sites - robots-txt x-fern-sdk-method-name: put security: - OAuth2: - site_config:write operationId: replace-robots-txt summary: Webflow Replace robots.txt description: 'Replace the `robots.txt` configuration for various user agents. This endpoint requires an Enterprise workspace. Required scope | `site_config:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml responses: '200': description: Request was successful content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] patch: x-fern-sdk-group-name: - sites - robots-txt x-fern-sdk-method-name: patch security: - OAuth2: - site_config:write operationId: update-robots-txt summary: Webflow Update robots.txt description: 'Update the `robots.txt` configuration for various user agents. This endpoint requires an Enterprise workspace. Required scope | `site_config:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml responses: '200': description: Request was successful content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - sites - robots-txt x-fern-sdk-method-name: delete security: - OAuth2: - site_config:write operationId: delete-robots-txt summary: Webflow Delete robots.txt description: '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. This endpoint requires an Enterprise workspace. Required scope: `site_config:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: '*' allows: [] disallows: - /bubbles responses: '200': description: Request was successful content: application/json: schema: type: object description: The robots.txt file for a given site properties: rules: type: array description: List of rules for user agents. items: type: object properties: userAgent: type: string description: The user agent the rules apply to. example: googlebot allows: type: array description: List of paths allowed for this user agent. items: type: string description: Allowed path for the user agent. example: /public disallows: type: array description: List of paths disallowed for this user agent. items: type: string description: Disallowed path for the user agent. example: /checkout required: - userAgent sitemap: type: string description: URL to the sitemap. example: https://heartofgold.ship/sitemap.xml example: rules: - userAgent: googlebot allows: [] disallows: - /vogon-poetry - /total-perspective-vortex sitemap: https://heartofgold.ship/sitemap.xml '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/well_known: put: x-fern-sdk-group-name: - sites - well-known x-fern-sdk-method-name: put security: - OAuth2: - site_config:write operationId: set-well-known summary: Webflow Set a well-known file description: "Upload a supported well-known file to a site.\n\nThe current restrictions on well-known files are as follows:\n - Each file must be smaller than 100kb\n - Less than 30 total files\n - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`\n\n \n `.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.\n \n\nThis endpoint requires an Enterprise workspace.\n\nRequired scope: `site_config:write`\n" tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: type: object required: - fileName - fileData properties: fileName: type: string description: The name of the file examples: example1: summary: Apple App Site Association value: apple-app-site-association.txt example2: summary: Apple Developer Merchant ID Domain Association value: apple-developer-merchantid-domain-association.txt fileData: type: string description: The contents of the file examples: example1: summary: Apple App Site Association File Example value: "{\n \"applinks\": {\n \"apps\": [],\n \"details\": [\n {\n \"appID\": \"ABCDE12345.com.example.app\",\n \"paths\": [ \"/*\", \"/some/path/*\" ]\n }\n ]\n }\n}\n" example2: summary: Apple Developer Merchant ID Domain Association File Example value: "{\n \"merchantId\": \"merchant.com.example\",\n \"merchantName\": \"Example Inc.\",\n \"domainAssociation\": \"web\"\n}\n" contentType: type: string default: application/json description: The content type of the file. Defaults to application/json enum: - application/json - text/plain example: application/json examples: appleAppSiteAssociation: summary: Apple App Site Association value: fileName: apple-app-site-association.txt fileData: "{\n \"applinks\": {\n \"apps\": [],\n \"details\": [\n {\n \"appID\": \"ABCDE12345.com.example.app\",\n \"paths\": [ \"/*\", \"/some/path/*\" ]\n }\n ]\n }\n}\n" contentType: application/json appleDeveloperMerchantIdDomainAssociation: summary: Apple Developer Merchant ID Domain Association value: fileName: apple-developer-merchantid-domain-association.txt fileData: "{\n \"merchantId\": \"merchant.com.example\",\n \"merchantName\": \"Example Inc.\",\n \"domainAssociation\": \"web\"\n}\n" contentType: text/plain responses: '201': description: File uploaded successfully '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - sites - well-known x-fern-sdk-method-name: delete security: - OAuth2: - site_config:write operationId: delete-well-known summary: Webflow Delete a well-known file description: 'Delete existing well-known files from a site. This endpoint requires an Enterprise workspace. Required scope: `site_config:write` ' tags: - Sites parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null requestBody: content: application/json: schema: properties: fileNames: type: array description: A list of file names to delete items: type: string example: - apple-app-site-association responses: '204': description: File deleted successfully '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /sites/{site_id}/activity_logs: get: x-fern-sdk-group-name: - sites - activity-logs x-fern-sdk-method-name: list summary: Webflow Get Site Activity Logs operationId: get-site-activity-logs description: 'Retrieve Activity Logs for a specific Site. This endpoint requires an Enterprise workspace. Required scope: `site_activity:read` ' tags: - Sites security: - OAuth2: - site_activity:read parameters: - name: site_id in: path description: Unique identifier for a Site example: 580e63e98c9a982ac9b8b741 required: true schema: type: string format: objectid default: null - in: query allowEmptyValue: true name: limit example: 100 description: 'Maximum number of records to be returned (max limit: 100)' required: false schema: type: integer - in: query example: 0 allowEmptyValue: true name: offset description: Offset used for pagination if the results have more than limit records required: false schema: type: integer responses: '200': description: A list of site activity logs content: application/json: schema: type: object properties: items: type: array items: type: object properties: id: type: string createdOn: type: string format: date-time lastUpdated: type: string format: date-time event: type: string enum: - styles_modified - site_published - ix2_modified_on_page - page_dom_modified - cms_item - backup_created - page_custom_code_modified - symbols_modified - variable_modified - variables_modified - cms_collection - page_settings_modified - page_settings_custom_code_modified - ix2_modified_on_component - ix2_modified_on_class - site_custom_code_modified - page_duplicated - secondary_locale_page_content_modified - page_renamed - page_created - page_deleted - site_unpublished - backup_restored - locale_added - branch_created - locale_display_name_updated - locale_subdirectory_updated - branch_merged - locale_tag_updated - branch_deleted - locale_enabled - locale_removed - locale_disabled - library_shared - library_unshared - library_installed - library_uninstalled - library_update_shared - library_update_accepted - branch_review_created - branch_review_approved - branch_review_canceled resourceOperation: type: string enum: - CREATED - MODIFIED - PUBLISHED - UNPUBLISHED - DELETED - GROUP_REORDERED - GROUP_CREATED - GROUP_DELETED - REORDERED user: type: object nullable: true properties: id: type: string displayName: type: string resourceId: type: string nullable: true resourceName: type: string nullable: true newValue: type: string nullable: true previousValue: type: string nullable: true payload: type: object nullable: true pagination: description: Pagination object type: object required: - limit - offset - total properties: limit: type: integer description: The limit used for pagination example: 100 readOnly: true offset: type: integer description: The offset used for pagination example: 0 readOnly: true total: type: integer description: The total number of records example: 100 readOnly: true example: items: - id: 654c16c7b229e56bcf26872d createdOn: '2023-11-08T23:16:23.496Z' lastUpdated: '2023-11-08T23:16:23.496Z' event: cms_collection user: id: 6509cd56e90eec668b009712 displayName: John Doe resourceOperation: CREATED resourceId: 654c16c7b229e56bcf26870c resourceName: foo-bar newValue: null previousValue: null payload: null pagination: total: 1 offset: 0 limit: 25 '403': description: Forbidden request content: application/json: schema: oneOf: - description: Provided access token is valid, but is missing the required scopes. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: missing_scopes message: 'OAuthForbidden: You are missing the following scopes - components:write' externalReference: null details: [] - description: Error response for non-enterprise plan sites. x-logErrorCode: 403 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_enterprise_plan_site message: This site is not associated with an Enterprise plan externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/items: get: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: list-items security: - OAuth2: - cms:read operationId: list-collection-items summary: Webflow List Collection Items description: 'List of all Items within a Collection. Required scope | `CMS:read` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: cmsLocaleId in: query allowEmptyValue: true description: 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. schema: type: string - in: query example: 0 allowEmptyValue: true name: offset description: Offset used for pagination if the results have more than limit records required: false schema: type: integer - in: query allowEmptyValue: true name: limit example: 100 description: 'Maximum number of records to be returned (max limit: 100)' required: false schema: type: integer - name: name in: query allowEmptyValue: true description: Filter by the exact name of the item(s) schema: type: string - name: slug in: query allowEmptyValue: true description: Filter by the exact slug of the item schema: type: string - name: lastPublished in: query allowEmptyValue: true description: Filter by the last published date of the item(s) schema: type: object properties: lte: type: string format: date-time example: '2024-04-22T16:00:31.000Z' description: Filter items last published before this date gte: type: string format: date-time example: '2024-04-19T16:00:31.000Z' description: Filter items last published after this date style: deepObject explode: true required: false - name: sortBy in: query allowEmptyValue: true description: Sort results by the provided value required: false schema: type: string enum: - lastPublished - name - slug - name: sortOrder in: query allowEmptyValue: true description: Sorts the results by asc or desc required: false schema: type: string enum: - asc - desc responses: '200': description: Request was successful content: application/json: schema: required: - items - pagination title: Collection Item List description: Results from collection items list example: items: - id: 62b720ef280c7a7a3be8cabe lastPublished: '2022-06-30T13:35:20.878Z' lastUpdated: '2022-06-25T14:51:27.809Z' createdOn: '2022-06-25T14:51:27.809Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - id: 62c880ef281c7b7b4cf9dabc lastPublished: '2023-04-15T10:25:18.123Z' lastUpdated: '2023-04-10T11:45:30.567Z' createdOn: '2023-04-10T11:45:30.567Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product pagination: limit: 25 offset: 0 total: 2 properties: items: type: array description: List of Items within the collection items: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf pagination: type: object properties: limit: type: integer default: 100 description: The limit specified in the request offset: type: integer default: 0 description: The offset specified for pagination total: type: integer description: Total number of items in the collection '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] post: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: create-item security: - OAuth2: - cms:write operationId: create-item summary: Webflow Create Collection Item(s) description: '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` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: description: Details of the item(s) to create content: application/json: schema: oneOf: - x-fern-type-name: Single Item title: Single Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' type: object required: - fieldData properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is in an archived state. isDraft: type: boolean default: true example: true description: Boolean determining if the Item is in a draft state. fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf - type: object x-fern-type-name: Multiple Items title: Multiple Items additionalProperties: false properties: items: type: array description: An array of items to create items: description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' type: object required: - fieldData properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is in an archived state. isDraft: type: boolean default: true example: true description: Boolean determining if the Item is in a draft state. fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf examples: SingleItem: value: isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf MultipleItems: value: items: - isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product responses: '202': description: Request was successful content: application/json: schema: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf examples: SingleItem: value: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf MultipleItems: value: items: - isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] patch: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: update-items security: - OAuth2: - cms:write operationId: update-items summary: Webflow Update Collection Items description: 'Update a single item or multiple items in a Collection. The limit for this endpoint is 100 items. Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: description: Details of the item to update content: application/json: schema: properties: items: type: array items: description: 'The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ' required: - id properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean description: Boolean determining if the Item is set to archived isDraft: type: boolean description: Boolean determining if the Item is set to draft fieldData: type: object properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf examples: LocalizedItems: value: items: - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca5 fieldData: name: Ne Paniquez Pas slug: ne-paniquez-pas featured: false - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca4 fieldData: name: No Entrar en Pánico slug: no-entrar-en-panico featured: false - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca5 fieldData: name: Au Revoir et Merci pour Tous les Poissons slug: au-revoir-et-merci featured: false - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca4 fieldData: name: Hasta Luego y Gracias por Todo el Pescado slug: hasta-luego-y-gracias featured: false MultipleItems: value: items: - isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product responses: '200': description: Request was successful content: application/json: schema: required: - id - fieldData - lastPublished - lastUpdated - createdOn - isArchived - isDraft oneOf: - title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf - title: Collection Item List description: Results from collection items list example: items: - id: 62b720ef280c7a7a3be8cabe lastPublished: '2022-06-30T13:35:20.878Z' lastUpdated: '2022-06-25T14:51:27.809Z' createdOn: '2022-06-25T14:51:27.809Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - id: 62c880ef281c7b7b4cf9dabc lastPublished: '2023-04-15T10:25:18.123Z' lastUpdated: '2023-04-10T11:45:30.567Z' createdOn: '2023-04-10T11:45:30.567Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product pagination: limit: 25 offset: 0 total: 2 properties: items: type: array description: List of Items within the collection items: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf pagination: type: object properties: limit: type: integer default: 100 description: The limit specified in the request offset: type: integer default: 0 description: The offset specified for pagination total: type: integer description: Total number of items in the collection examples: LocalizedItems: value: items: - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Ne Paniquez Pas slug: ne-paniquez-pas featured: false - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: name: No Entrar en Pánico slug: no-entrar-en-panico featured: false - id: 66f6ed9576ddacf3149d5eaa lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Au Revoir et Merci pour Tous les Poissons slug: au-revoir-et-merci featured: false - id: 66f6ed9576ddacf3149d5eaa lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: name: Hasta Luego y Gracias por Todo el Pescado slug: hasta-luego-y-gracias featured: false pagination: limit: 25 offset: 0 total: 4 MultipleItems: value: items: - id: 62b720ef280c7a7a3be8cabe lastPublished: '2022-06-30T13:35:20.878Z' lastUpdated: '2022-06-25T14:51:27.809Z' createdOn: '2022-06-25T14:51:27.809Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - id: 62c880ef281c7b7b4cf9dabc lastPublished: '2023-04-15T10:25:18.123Z' lastUpdated: '2023-04-10T11:45:30.567Z' createdOn: '2023-04-10T11:45:30.567Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product pagination: limit: 25 offset: 0 total: 2 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: delete-items security: - OAuth2: - cms:write operationId: delete-items summary: Webflow Delete Collection Items description: 'Delete Items from a Collection. Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid requestBody: description: Details of the items to delete content: application/json: schema: required: - items properties: items: type: array items: type: object required: - id properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleIds: type: array description: Array of identifiers for the locales where the item will be created items: type: string description: CMS Locale ID example: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 responses: '204': description: Request was successful '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: Site is published to multiple domains at different times x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: message: '''Site is published to multiple domains at different times' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/items/live: get: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: list-items-live servers: - url: https://api.webflow.com/v2 x-fern-server-name: Data API - url: https://api-cdn.webflow.com/v2 x-fern-server-name: Content Delivery API security: - OAuth2: - cms:read operationId: list-collection-items-live summary: Webflow List Live Collection Items description: "List all published items in a collection.\n\n\n 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.\n\n\nRequired scope | `CMS:read`\n" tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: cmsLocaleId in: query allowEmptyValue: true description: 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. schema: type: string - in: query example: 0 allowEmptyValue: true name: offset description: Offset used for pagination if the results have more than limit records required: false schema: type: integer - in: query allowEmptyValue: true name: limit example: 100 description: 'Maximum number of records to be returned (max limit: 100)' required: false schema: type: integer - name: name in: query allowEmptyValue: true description: Filter by the exact name of the item(s) schema: type: string - name: slug in: query allowEmptyValue: true description: Filter by the exact slug of the item schema: type: string - name: lastPublished in: query allowEmptyValue: true description: Filter by the last published date of the item(s) schema: type: object properties: lte: type: string format: date-time example: '2024-04-22T16:00:31.000Z' description: Filter items last published before this date gte: type: string format: date-time example: '2024-04-19T16:00:31.000Z' description: Filter items last published after this date style: deepObject explode: true required: false - name: sortBy in: query allowEmptyValue: true description: Sort results by the provided value required: false schema: type: string enum: - lastPublished - name - slug - name: sortOrder in: query allowEmptyValue: true description: Sorts the results by asc or desc required: false schema: type: string enum: - asc - desc responses: '200': description: Request was successful content: application/json: schema: title: Collection Item List description: Results from collection items list example: items: - id: 62b720ef280c7a7a3be8cabe lastPublished: '2022-06-30T13:35:20.878Z' lastUpdated: '2022-06-25T14:51:27.809Z' createdOn: '2022-06-25T14:51:27.809Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - id: 62c880ef281c7b7b4cf9dabc lastPublished: '2023-04-15T10:25:18.123Z' lastUpdated: '2023-04-10T11:45:30.567Z' createdOn: '2023-04-10T11:45:30.567Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product pagination: limit: 25 offset: 0 total: 2 properties: items: type: array description: List of Items within the collection items: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf pagination: type: object properties: limit: type: integer default: 100 description: The limit specified in the request offset: type: integer default: 0 description: The offset specified for pagination total: type: integer description: Total number of items in the collection required: - items - pagination '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] post: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: create-item-live security: - OAuth2: - cms:write operationId: create-item-live summary: Webflow Create Live Collection Item(s) description: '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` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: description: Details of the item(s) to create content: application/json: schema: oneOf: - title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf x-fern-type-name: Single Live Item - type: object x-fern-type-name: Multiple Live Items title: Multiple Live Items properties: items: type: array description: List of collection items to create items: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf examples: SingleItem: value: isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf MultipleItems: value: items: - isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product responses: '202': description: Request was successful content: application/json: schema: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] patch: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: update-items-live security: - OAuth2: - cms:write operationId: update-items-live summary: Webflow Update Live Collection Items description: 'Update a single published item or multiple published items (up to 100) in a Collection Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: description: Details of the live items to update content: application/json: schema: properties: items: type: array items: description: 'The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ' required: - id properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean description: Boolean determining if the Item is set to archived isDraft: type: boolean description: Boolean determining if the Item is set to draft fieldData: type: object properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf examples: LocalizedItems: value: items: - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca5 fieldData: name: Ne Paniquez Pas slug: ne-paniquez-pas featured: false - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca4 fieldData: name: No Entrar en Pánico slug: no-entrar-en-panico featured: false - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca5 fieldData: name: Au Revoir et Merci pour Tous les Poissons slug: au-revoir-et-merci featured: false - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca4 fieldData: name: Hasta Luego y Gracias por Todo el Pescado slug: hasta-luego-y-gracias featured: false MultipleItems: value: items: - isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product responses: '200': description: Request was successful content: application/json: schema: required: - id - fieldData - lastPublished - lastUpdated - createdOn - isArchived - isDraft description: Results from collection items list example: items: - id: 62b720ef280c7a7a3be8cabe lastPublished: '2022-06-30T13:35:20.878Z' lastUpdated: '2022-06-25T14:51:27.809Z' createdOn: '2022-06-25T14:51:27.809Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - id: 62c880ef281c7b7b4cf9dabc lastPublished: '2023-04-15T10:25:18.123Z' lastUpdated: '2023-04-10T11:45:30.567Z' createdOn: '2023-04-10T11:45:30.567Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product pagination: limit: 25 offset: 0 total: 2 properties: items: type: array description: List of Items within the collection items: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf examples: LocalizedItems: summary: Multiple items updated across multiple locales value: items: - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Ne Paniquez Pas slug: ne-paniquez-pas featured: false - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: name: No Entrar en Pánico slug: no-entrar-en-panico featured: false - id: 66f6ed9576ddacf3149d5eaa lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Au Revoir et Merci pour Tous les Poissons slug: au-revoir-et-merci featured: false - id: 66f6ed9576ddacf3149d5eaa lastPublished: '2024-09-27T17:38:29.066Z' lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' cmsLocaleId: 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: name: Hasta Luego y Gracias por Todo el Pescado slug: hasta-luego-y-gracias featured: false pagination: limit: 25 offset: 0 total: 4 MultipleItems: summary: Multiple items updated in a single locale value: items: - id: 62b720ef280c7a7a3be8cabe lastPublished: '2022-06-30T13:35:20.878Z' lastUpdated: '2022-06-25T14:51:27.809Z' createdOn: '2022-06-25T14:51:27.809Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Senior Data Analyst slug: senior-data-analyst url: https://boards.greenhouse.io/webflow/jobs/26567701 department: Data - id: 62c880ef281c7b7b4cf9dabc lastPublished: '2023-04-15T10:25:18.123Z' lastUpdated: '2023-04-10T11:45:30.567Z' createdOn: '2023-04-10T11:45:30.567Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Product Manager slug: product-manager url: https://boards.greenhouse.io/webflow/jobs/31234567 department: Product pagination: limit: 25 offset: 0 total: 2 '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: Conflict with server data. Item not published content: application/json: schema: description: Resource conflict x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: conflict message: 'Conflict: Resource already exists' externalReference: null details: [] example: code: conflict message: 'Conflict: Conflict with server data: Live PATCH updates can''t be applied to items that have never been published' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: delete-items-live security: - OAuth2: - cms:write operationId: delete-items-live summary: Webflow Unpublish Live Collection Items description: 'Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid requestBody: description: Details of the live items to delete content: application/json: schema: required: - items properties: items: type: array items: type: object required: - id properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleIds: type: array description: Array of identifiers for the locales where the item will be created items: type: string description: CMS Locale ID example: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 responses: '204': description: Request was successful '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/items/bulk: post: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: create-items security: - OAuth2: - cms:write operationId: create-items summary: Webflow Create Collection Items description: "Create an item or multiple items in a CMS Collection across multiple corresponding locales.\n\n\n - This endpoint can create up to 100 items in a request.\n - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale.\n\n\nRequired scope | `CMS:write`\n" tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: content: application/json: schema: description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - fieldData properties: cmsLocaleIds: type: array description: Array of identifiers for the locales where the item will be created items: type: string description: CMS Locale ID example: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date and time when the item was last published. lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date and time when the item was last updated. createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date and time when the item was created. isArchived: type: boolean default: false description: Indicates whether the item is archived. isDraft: type: boolean default: true description: Indicates whether the item is in draft state. fieldData: oneOf: - type: object x-fern-type-name: Single CMS Item title: Single CMS Item additionalProperties: true properties: name: type: string description: The name of the item. slug: type: string description: 'URL slug for the item in your site. Note: Updating the item slug will break all links referencing the old slug.' required: - name - slug - type: array x-fern-type-name: Multiple CMS Items title: Multiple CMS Items description: A list of CMS items to create items: type: object description: A single CMS item to create additionalProperties: true properties: name: type: string description: The name of the item. slug: type: string description: 'URL slug for the item in your site. Note: Updating the item slug will break all links referencing the old slug.' required: - name - slug examples: SingleItemMultipleLocales: summary: Create a single item across multiple locales value: cmsLocaleIds: - 66f6e966c9e1dc700a857ca3 - 66f6e966c9e1dc700a857ca4 - 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Don’t Panic slug: dont-panic MultipleItemsMultipleLocales: summary: Create multiple items across multipel locales value: cmsLocaleIds: - 66f6e966c9e1dc700a857ca3 - 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: - name: Don’t Panic slug: dont-panic - name: So Long and Thanks for All the Fish slug: so-long-and-thanks examples: SingleItemMultipleLocales: summary: Create a single item across multiple locales value: cmsLocaleIds: - 66f6e966c9e1dc700a857ca3 - 66f6e966c9e1dc700a857ca4 - 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Don’t Panic slug: dont-panic MultipleItemsMultipleLocales: summary: Create multiple items across multiple locales value: cmsLocaleIds: - 66f6e966c9e1dc700a857ca3 - 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: - name: Don’t Panic slug: dont-panic - name: So Long and Thanks for All the Fish slug: so-long-and-thanks responses: '202': description: Request was successful content: application/json: schema: required: - id - cmsLocaleIds - fieldData - lastPublished - lastUpdated - createdOn - isArchived - isDraft description: 'The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ' properties: id: type: string example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleIds: type: array description: Array of identifiers for the locales where the item will be created items: type: string description: CMS Locale ID example: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 lastPublished: type: string format: date-string nullable: true readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: items: - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-02-28T19:25:39.942Z' lastUpdated: '2024-02-28T19:25:39.942Z' createdOn: '2024-02-28T19:25:39.942Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-02-28T19:25:39.942Z' lastUpdated: '2024-02-28T19:25:39.942Z' createdOn: '2024-02-28T19:25:39.942Z' cmsLocaleId: 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-02-28T19:25:39.942Z' lastUpdated: '2024-02-28T19:25:39.942Z' createdOn: '2024-02-28T19:25:39.942Z' cmsLocaleId: 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Don't Panic slug: dont-panic examples: SingleItemMultipleLocales: summary: Single item created across multiple locales value: items: - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-02-28T19:25:39.942Z' lastUpdated: '2024-02-28T19:25:39.942Z' createdOn: '2024-02-28T19:25:39.942Z' cmsLocaleId: 66f6e966c9e1dc700a857ca3 isArchived: false isDraft: false fieldData: name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-02-28T19:25:39.942Z' lastUpdated: '2024-02-28T19:25:39.942Z' createdOn: '2024-02-28T19:25:39.942Z' cmsLocaleId: 66f6e966c9e1dc700a857ca4 isArchived: false isDraft: false fieldData: name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5ea6 lastPublished: '2024-02-28T19:25:39.942Z' lastUpdated: '2024-02-28T19:25:39.942Z' createdOn: '2024-02-28T19:25:39.942Z' cmsLocaleId: 66f6e966c9e1dc700a857ca5 isArchived: false isDraft: false fieldData: name: Don't Panic slug: dont-panic MultipleItemsMultipleLocales: summary: Multiple items created across multiple locales value: items: - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca3 lastPublished: null lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' isArchived: false isDraft: false fieldData: featured: false name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca4 lastPublished: null lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' isArchived: false isDraft: false fieldData: featured: false name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5ea6 cmsLocaleId: 66f6e966c9e1dc700a857ca5 lastPublished: null lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' isArchived: false isDraft: false fieldData: featured: false name: Don't Panic slug: dont-panic - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca3 lastPublished: null lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' isArchived: false isDraft: false fieldData: featured: false name: So Long and Thanks for All the Fish slug: so-long-and-thanks - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca4 lastPublished: null lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' isArchived: false isDraft: false fieldData: featured: false name: So Long and Thanks for All the Fish slug: so-long-and-thanks - id: 66f6ed9576ddacf3149d5eaa cmsLocaleId: 66f6e966c9e1dc700a857ca5 lastPublished: null lastUpdated: '2024-09-27T17:38:29.066Z' createdOn: '2024-09-27T17:38:29.066Z' isArchived: false isDraft: false fieldData: featured: false name: So Long and Thanks for All the Fish slug: so-long-and-thanks '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/items/{item_id}: get: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: get-item security: - OAuth2: - cms:read operationId: Get-Item summary: Webflow Get Collection Item description: 'Get details of a selected Collection Item. Required scope | `CMS:read` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: item_id in: path description: Unique identifier for an Item example: 580e64008c9a982ac9b8b754 required: true schema: type: string format: objectid - name: cmsLocaleId in: query allowEmptyValue: true description: 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. schema: type: string responses: '200': description: Request was successful content: application/json: schema: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] patch: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: update-item security: - OAuth2: - cms:write operationId: update-item summary: Webflow Update Collection Item description: 'Update a selected Item in a Collection. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: item_id in: path description: Unique identifier for an Item example: 580e64008c9a982ac9b8b754 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: description: Details of the item to update content: application/json: schema: description: 'The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ' properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean description: Boolean determining if the Item is set to archived isDraft: type: boolean description: Boolean determining if the Item is set to draft fieldData: type: object properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf responses: '200': description: Request was successful content: application/json: schema: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: delete-item security: - OAuth2: - cms:write operationId: delete-item summary: Webflow Delete Collection Item description: 'Delete an item from a collection. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: item_id in: path description: Unique identifier for an Item example: 580e64008c9a982ac9b8b754 required: true schema: type: string format: objectid - name: cmsLocaleId in: query allowEmptyValue: true description: 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. schema: type: string responses: '204': description: Request was successful '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/items/{item_id}/live: get: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: get-item-live servers: - url: https://api.webflow.com/v2 x-fern-server-name: Data API - url: https://api-cdn.webflow.com/v2 x-fern-server-name: Content Delivery API security: - OAuth2: - cms:read operationId: get-item-live summary: Webflow Get Live Collection Item description: "Get details of a selected Collection live Item.\n\n\n 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.\n\n\nRequired scope | `CMS:read`\n" tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: item_id in: path description: Unique identifier for an Item example: 580e64008c9a982ac9b8b754 required: true schema: type: string format: objectid - name: cmsLocaleId in: query allowEmptyValue: true description: 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. schema: type: string responses: '200': description: Request was successful content: application/json: schema: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] patch: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: update-item-live security: - OAuth2: - cms:write operationId: update-item-live summary: Webflow Update Live Collection Item description: 'Update a selected live Item in a Collection. The updates for this Item will be published to the live site. Required scope | `CMS:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: item_id in: path description: Unique identifier for an Item example: 580e64008c9a982ac9b8b754 required: true schema: type: string format: objectid - name: skipInvalidFiles in: query allowEmptyValue: true description: When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. schema: type: boolean default: true example: true required: false requestBody: description: Details of the item to update content: application/json: schema: description: 'The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ' properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean description: Boolean determining if the Item is set to archived isDraft: type: boolean description: Boolean determining if the Item is set to draft fieldData: type: object properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf responses: '200': description: Request was successful content: application/json: schema: title: Collection Item description: 'A Collection Item represents a single entry in your collection. Each item includes: - **System metadata** - Automatically managed fields like IDs and timestamp
- **Status flags** - Controls for managing content state: `isDraft`, `isArchived `
- **Content fields** - Stored in `fieldData`. Each item needs a `name` and `slug`, and may include additional fields matching your collection''s schema definition. ' required: - id - fieldData - lastPublished - lastUpdated - createdOn properties: id: type: string readOnly: true example: 580e64008c9a982ac9b8b754 description: Unique identifier for the Item cmsLocaleId: type: string example: 653ad57de882f528b32e810e description: Identifier for the locale of the CMS item lastPublished: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last published lastUpdated: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was last updated createdOn: type: string format: date-string readOnly: true example: '2023-03-17T18:47:35.560Z' description: The date the item was created isArchived: type: boolean default: false description: Boolean determining if the Item is set to archived isDraft: type: boolean default: false description: Boolean determining if the Item is set to draft fieldData: type: object required: - name - slug properties: name: type: string description: Name of the Item slug: type: string description: 'URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.' additionalProperties: true example: date: '2022-11-18T00:00:00.000Z' featured: false name: My new item slug: my-new-item color: '#db4b68' example: id: 42b720ef280c7a7a3be8cabe cmsLocaleId: 653ad57de882f528b32e810e lastPublished: '2022-11-29T16:22:43.159Z' lastUpdated: '2022-11-17T17:19:43.282Z' createdOn: '2022-11-17T17:11:57.148Z' isArchived: false isDraft: false fieldData: name: The Hitchhiker's Guide to the Galaxy slug: hitchhikers-guide-to-the-galaxy plain-text: Don't Panic. rich-text:

A Guide to Interstellar Travel

A towel is about the most massively useful thing an interstellar hitchhiker can have. Don't forget yours!

main-image: fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png image-gallery: - fileId: 62b720ef280c7a7a3be8cabd url: /files/62b720ef280c7a7a3be8cabd_image.png - fileId: 62b720ef280c7a7a3be8cabe url: /files/62b720ef280c7a7a3be8cabe_image.png intro-video: https://www.youtube.com/watch?v=aJ83KAggd-4 official-site: https://hitchhikers.fandom.com/wiki/The_Hitchhiker%27s_Guide_to_the_Galaxy contact-email: zaphod.beeblebrox@heartofgold.gov support-phone: 424-242-4242 answer-to-everything: 42 release-date: '1979-10-12T00:00:00.000Z' is-featured: true brand-color: '#000000' category: 62b720ef280c7a7a3be8cabf author: 62b720ef280c7a7a3be8cab0 tags: - 62b720ef280c7a7a3be8cab1 - 62b720ef280c7a7a3be8cab2 downloadable-asset: fileId: 62b720ef280c7a7a3be8cab3 url: /files/62b720ef280c7a7a3be8cab3_document.pdf '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: Conflict with server data. Item not published content: application/json: schema: description: Resource conflict x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: conflict message: 'Conflict: Resource already exists' externalReference: null details: [] example: code: conflict message: 'Conflict: Conflict with server data: Live PATCH updates can''t be applied to items that have never been published' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] delete: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: delete-item-live security: - OAuth2: - cms:write operationId: delete-item-live summary: Webflow Unpublish Live Collection Item description: '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` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid - name: item_id in: path description: Unique identifier for an Item example: 580e64008c9a982ac9b8b754 required: true schema: type: string format: objectid - name: cmsLocaleId in: query allowEmptyValue: true description: 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. schema: type: string responses: '204': description: Request was successful '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] /collections/{collection_id}/items/publish: post: x-fern-sdk-group-name: - collections - items x-fern-sdk-method-name: publish-item security: - OAuth2: - cms:write operationId: publish-item summary: Webflow Publish Collection Item description: 'Publish an item or multiple items. Required scope | `cms:write` ' tags: - Sites parameters: - name: collection_id in: path description: Unique identifier for a Collection example: 580e63fc8c9a982ac9b8b745 required: true schema: type: string format: objectid requestBody: description: An array of Item IDs content: application/json: schema: oneOf: - type: object x-fern-type-name: Item IDs title: Item IDs description: An array of Item IDs in a single locale properties: itemIds: type: array items: type: string format: objectid example: itemIds: - 643fd856d66b6528195ee2ca - 643fd856d66b6528195ee2cb - 643fd856d66b6528195ee2cc - type: object x-fern-type-name: Item IDs with Locales title: Item IDs with Locales description: An array of Item IDs with included `cmsLocaleIds` properties: items: type: array items: type: object required: - id properties: id: description: The ID of the CMS item type: string format: objectid example: 643fd856d66b6528195ee2ca cmsLocaleIds: type: array description: Array of identifiers for the locales where the item will be published items: type: string description: CMS Locale ID example: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 example: value: items: - id: 643fd856d66b6528195ee2ca cmsLocaleIds: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 - id: 643fd856d66b6528195ee2cb cmsLocaleIds: - 653ad57de882f528b32e810e examples: PrimaryLocale: value: itemIds: - 643fd856d66b6528195ee2ca - 643fd856d66b6528195ee2cb - 643fd856d66b6528195ee2cc SecondaryLocale: value: items: - id: 643fd856d66b6528195ee2ca cmsLocaleIds: - 653ad57de882f528b32e810e - id: 643fd856d66b6528195ee2cb cmsLocaleIds: - 653ad57de882f528b32e810e - id: 643fd856d66b6528195ee2cc cmsLocaleIds: - 653ad57de882f528b32e810e MultipleLocales: value: items: - id: 643fd856d66b6528195ee2ca cmsLocaleIds: - 653ad57de882f528b32e810e - 6514390aea353fc691d69827 - 65143930ea353fc691d69cd8 responses: '202': description: Request was successful content: application/json: schema: type: object properties: publishedItemIds: type: array items: type: string errors: type: array items: type: string example: publishedItemIds: - 643fd856d66b6528195ee2ca - 643fd856d66b6528195ee2cb errors: - Staging item ID 643fd856d66b6528195ee2cf not found. '400': description: Request body was incorrectly formatted. x-logErrorCode: 400 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: bad_request message: 'Bad Request: Request is malformed' externalReference: null details: [] '401': description: Provided access token is invalid or does not have access to requested resource x-logErrorCode: 401 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: not_authorized message: Request not authorized externalReference: null details: [] '404': description: Requested resource not found x-logErrorCode: 404 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: resource_not_found message: 'Requested resource not found: The site cannot be found' externalReference: null details: [] '409': description: Site is published to multiple domains at different times x-logErrorCode: 409 content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: message: '''Site is published to multiple domains at different times' externalReference: null details: [] '429': description: The rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header we include on API responses. x-logErrorCode: 429 headers: X-RateLimit-Remaining: description: Contains the number of available requests remaining in the current minute schema: type: number X-RateLimit-Limit: description: Contains your current overall rate limit per minute schema: type: number content: application/json: schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: too_many_requests message: Too many requests externalReference: null details: [] '500': description: We had a problem with our server. Try again later. content: application/json: x-logErrorCode: 500 schema: type: object example: code: not_authorized message: Request not authorized externalReference: null details: [] properties: code: type: string description: Error code example: not_authorized enum: - bad_request - collection_not_found - conflict - duplicate_collection - duplicate_user_email - ecommerce_not_enabled - forbidden - forms_require_republish - incompatible_webhook_filter - internal_error - invalid_auth_version - invalid_credentials - invalid_domain - invalid_user_email - item_not_found - missing_scopes - no_domains - not_authorized - not_enterprise_plan_site - not_enterprise_plan_workspace - order_not_found - resource_not_found - too_many_requests - unsupported_version - unsupported_webhook_trigger_type - user_limit_reached - user_not_found - users_not_enabled - validation_error message: type: string description: Error message example: Request not authorized externalReference: type: string description: Link to more information example: '' details: type: array description: Array of errors items: - type: string example: Invalid email address description: Error message - type: object example: field: email message: Invalid email address description: Error message example: [] example: code: internal_error message: An Internal Error occurred externalReference: null details: [] components: securitySchemes: OAuth2: type: oauth2 flows: authorizationCode: scopes: authorized_user:read: read details about the authorized user assets:read: read assets on the site assets:write: write assets on a site cms:read: read collections and items for a site cms:write: write to collections and items for a site comments:read: read comments on the site comments:write: write comments on the site custom_code:read: read custom code on the site custom_code:write: modify custom code on the site ecommerce:read: read ecommerce data ecommerce:write: edit ecommerce data forms:read: read form data forms:write: write form data pages:read: read pages on the site pages:write: write to pages on the site components:read: read component data components:write: write component data sites:read: read sites on the site sites:write: modify pages on the site users:read: read users on the site site_activity:read: read site activity logs users:write: modify users on the site workspace:read: read workspace resource data workspace:write: write workspace resource data site_config:read: read site configuration data site_config:write: write site configuration data authorizationUrl: https://webflow.com/oauth/authorize tokenUrl: https://api.webflow.com/oauth/token ApiKey: type: http scheme: bearer x-fern-token-variable-name: access_token