bucket_update

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": [
    "bucket_id"
  ],
  "properties": {
    "bucket_id": {
      "type": "string",
      "description": "Revdoku bucket id returned by bucket_list or bucket_get, for example bkt_..."
    },
    "title": {
      "type": "string",
      "description": "Human-readable title for the bucket or website publication."
    },
    "description": {
      "type": "string",
      "description": "Optional human-readable description for the bucket or website publication."
    },
    "allow_search_indexing": {
      "type": "boolean",
      "description": "Allow search engines to index this public website. Public permanent websites default to true. Set false to add Revdoku noindex controls. Protected websites and previews are locked off."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "Optional JSON metadata stored with the bucket. Use publication_forms to configure Revdoku's built-in forms and publication_show_download_button to control Auto-Index viewer downloads.",
      "properties": {
        "allow_search_indexing": {
          "type": [
            "boolean",
            "object"
          ],
          "description": "Compatibility metadata form of the affirmative search setting. Prefer the top-level allow_search_indexing argument on bucket_create or bucket_update."
        },
        "publication_show_download_button": {
          "type": [
            "boolean",
            "object"
          ],
          "description": "Show the Download action in generated Auto-Index file viewers. Use {enabled:true} or {enabled:false}; false also blocks Revdoku's explicit published-file download route. Viewing still transfers file data to the browser."
        },
        "publication_forms": {
          "type": "object",
          "additionalProperties": true,
          "description": "Built-in form configuration. Changes are saved as a draft and require publish/republish before they affect the live website.",
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Enable the configured built-in form endpoints."
            },
            "notify": {
              "type": "boolean",
              "description": "Email the bucket owner when a form submission is received."
            },
            "reply_to_submitter": {
              "type": "boolean",
              "description": "Use a valid submitted email address as Reply-To in owner notifications."
            },
            "turnstile": {
              "type": "string",
              "enum": [
                "auto",
                "on",
                "off"
              ],
              "description": "Spam-check mode. Use auto unless the user explicitly requests another mode."
            },
            "inline_theme": {
              "type": "string",
              "enum": [
                "auto",
                "light",
                "dark"
              ],
              "description": "Inline hosted-form color theme. auto uses the nearest page background; paid plans may select light or dark."
            },
            "forms": {
              "type": "array",
              "maxItems": 8,
              "description": "Configured form instances and widgets. Inline/popup presets do not need a settings entry; their explicit HTML markers register them at publish. Free plans may use unchanged predefined templates. Paid plans may customize copy and fields and reuse a template with unique endpoint names. Render one inline with {{REVDOKU_FORM:name}} (or {{REVDOKU_FORM}} for the first configured form, defaulting to Feedback), or open any registered form from a native button with data-revdoku-form-popup=\"name\".",
              "items": {
                "type": "object",
                "required": [
                  "name",
                  "template"
                ],
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$",
                    "description": "Stable endpoint name. Use the template key on Free; paid plans may use a unique slug such as contact-2."
                  },
                  "template": {
                    "type": "string",
                    "enum": [
                      "booking",
                      "blank",
                      "feedback",
                      "comments",
                      "resource",
                      "get_in_touch",
                      "waitlist",
                      "contact",
                      "quote",
                      "information",
                      "support"
                    ],
                    "description": "Behavior template. get_in_touch collects a required email with optional contact details; support collects a required email and support request; booking includes an optional date. comments supports shared feedback on any site; public visitors can read approved comments; public/password sites accept guests with optional name/email; Require Email sites reuse their gate login. blank and copy/field customization require a paid plan."
                  },
                  "label": {
                    "type": "string",
                    "maxLength": 80,
                    "description": "Visitor-facing title. Custom values require a paid plan."
                  },
                  "description": {
                    "type": "string",
                    "maxLength": 240,
                    "description": "Optional visitor-facing description. Custom values require a paid plan."
                  },
                  "widget_mode": {
                    "type": "string",
                    "enum": [
                      "hidden",
                      "auto",
                      "always_show"
                    ],
                    "description": "Floating widget placement, available on every plan. always_show (default for configured forms) also shows beside embeds; auto hides only when this same form is embedded on the current page; hidden renders inline/popup only. Known presets embedded in HTML are registered automatically at publish with hidden mode."
                  },
                  "hosted": {
                    "type": "boolean",
                    "description": "Legacy placement flag. false maps to widget_mode=hidden. Prefer widget_mode."
                  },
                  "show_floating_with_embeds": {
                    "type": "boolean",
                    "description": "Legacy placement flag: true maps to always_show and false to auto. An explicit widget_mode takes precedence."
                  },
                  "show_floating_with_inline": {
                    "type": "boolean",
                    "description": "Deprecated compatibility alias for show_floating_with_embeds. New integrations should omit this key."
                  },
                  "floating_exclude_path_patterns": {
                    "type": "array",
                    "maxItems": 25,
                    "uniqueItems": true,
                    "items": {
                      "type": "string",
                      "maxLength": 200
                    },
                    "description": "Paid customization for this hosted form only. Each line is a case-sensitive safe path regex beginning with / or ^/; groups, alternation, counted quantifiers, and multiple * or + operators are not supported. A match hides only this form's auto-injected floating widget. Queries, fragments, inline forms, hand-authored forms, and submission endpoints are unaffected."
                  },
                  "approval_required": {
                    "type": "boolean",
                    "description": "Shared feedback only, available on every plan. Default true; set false to autoapprove future submissions. New visitor comments and replies stay pending until approved in the dashboard; changing this setting does not approve existing submissions."
                  },
                  "field_types_version": {
                    "type": "integer",
                    "enum": [
                      1
                    ],
                    "description": "Set to 1 when editing field types. Comment fields enable text and area selection; ordinary Text fields retain only the page/file reference."
                  },
                  "area_selection_enabled": {
                    "type": "boolean",
                    "description": "Legacy selection setting for older feedback forms. New forms derive selection support from a Comment field."
                  },
                  "fields": {
                    "type": "array",
                    "maxItems": 6,
                    "uniqueItems": true,
                    "items": {
                      "type": "object",
                      "required": [
                        "name"
                      ],
                      "additionalProperties": false,
                      "properties": {
                        "name": {
                          "type": "string",
                          "enum": [
                            "name",
                            "email",
                            "phone",
                            "company",
                            "budget",
                            "date",
                            "message",
                            "comment"
                          ],
                          "description": "Name value."
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "text",
                            "email",
                            "tel",
                            "textarea",
                            "comment",
                            "date"
                          ],
                          "description": "Message and Comment fields may use textarea (plain Text) or comment (text/area selections). At most one Comment field per form. Other fields keep their catalog type."
                        },
                        "label": {
                          "type": "string",
                          "maxLength": 80,
                          "description": "Value for label."
                        },
                        "placeholder": {
                          "type": "string",
                          "maxLength": 120,
                          "description": "Optional input placeholder, separate from the field label. Revdoku appends (required) or (optional) when the text omits either marker. Custom values require a paid plan."
                        },
                        "required": {
                          "type": "boolean",
                          "description": "Value for required."
                        }
                      }
                    },
                    "description": "Ordered fields, placeholders, and requirements. Omit for the exact template preset; any custom list, label, or placeholder requires a paid plan."
                  },
                  "widget_position": {
                    "type": "object",
                    "additionalProperties": false,
                    "description": "Paid customization. Independent floating-widget anchors for desktop and mobile. Omit to use bottom-right.",
                    "properties": {
                      "desktop": {
                        "type": "string",
                        "enum": [
                          "top-left",
                          "top-center",
                          "top-right",
                          "center-left",
                          "center",
                          "center-right",
                          "bottom-left",
                          "bottom-center",
                          "bottom-right"
                        ],
                        "description": "Desktop anchor for this form's floating widget."
                      },
                      "mobile": {
                        "type": "string",
                        "enum": [
                          "top-left",
                          "top-center",
                          "top-right",
                          "center-left",
                          "center",
                          "center-right",
                          "bottom-left",
                          "bottom-center",
                          "bottom-right"
                        ],
                        "description": "Mobile anchor for this form's floating widget."
                      }
                    }
                  },
                  "success_response": {
                    "type": "object",
                    "additionalProperties": false,
                    "description": "What the visitor sees after Revdoku stores the submission. Opening a viewer-supported resource requires a paid plan and publish/republish.",
                    "properties": {
                      "mode": {
                        "type": "string",
                        "enum": [
                          "system",
                          "file"
                        ],
                        "description": "system shows Revdoku's confirmation; on paid plans, file opens a supported website resource through a six-hour signed viewer link."
                      },
                      "path": {
                        "type": "string",
                        "description": "Required for file mode. Website-relative path such as downloads/guide.pdf to a viewer-supported PDF, image, video, audio, text, CSV, DOCX, or spreadsheet."
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "account_id": {
      "type": "string",
      "description": "Optional account id from revdoku_status.accounts for this call only. Omit for the credential's default account. Client accounts require explicit Agency authorization; never infer an account from a bucket id."
    }
  }
}