Skip to content
Website BuddyWebsite BuddyWebsite builder
Sign inGet started
API reference/Forms

Change a form's settings

Try it

Changes a form's name, its thank-you sentence, who gets a copy of each message, and the confirmation email to the person who filled it in (`confirmation`: on, subject, words, include_answers — sent once per message to the first answered Email question, in the business's name, never for spam). Only the fields you send change. Questions are changed in the form builder. Live at once — no publish.

PATCH/api/v1/sites/{site_id}/forms/{form_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the forms:write scope — mark messages read, unread or spam.

forms:writeChanges the draft or a recordIdempotency-Key optionalMCP tool: update_form

Parameters

Named placeholders go in the path; the rest in a JSON body.

site_idstringPath · required
The site's id.1 to 100 characters
form_idstringPath · required
The form's id.1 to 100 characters
namestringBody · optional
Only you see it — in the inbox and the editor's form picker.2 to 80 characters
success_messagestringBody · optional
What the page says after someone sends it.2 to 300 characters
notify_emailsarray of stringBody · optional
Up to five addresses that get a copy of each message. [] = inbox only.
confirmationobjectBody · optional

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X PATCH 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/forms/FORM_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"confirmation":{"on":true,"subject":"We got your quote request","words":"Thanks — we'll call you within one working day with a price.","include_answers":true}}'
Example arguments
{
  "site_id": "SITE_ID",
  "form_id": "FORM_ID",
  "confirmation": {
    "on": true,
    "subject": "We got your quote request",
    "words": "Thanks — we'll call you within one working day with a price.",
    "include_answers": true
  }
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "text",
              "email",
              "phone",
              "textarea",
              "select",
              "checkbox",
              "date",
              "file"
            ]
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "show_when": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "field_id": {
                    "type": "string"
                  },
                  "is": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "field_id",
                  "is"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "label",
          "kind",
          "required",
          "options",
          "show_when"
        ],
        "additionalProperties": false
      }
    },
    "success_message": {
      "type": "string"
    },
    "notify_emails": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "confirmation": {
      "type": "object",
      "properties": {
        "on": {
          "type": "boolean"
        },
        "subject": {
          "type": "string"
        },
        "words": {
          "type": "string"
        },
        "include_answers": {
          "type": "boolean"
        }
      },
      "required": [
        "on",
        "subject",
        "words",
        "include_answers"
      ],
      "additionalProperties": false
    },
    "message_count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "unread_count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "is_sample": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "name",
    "fields",
    "success_message",
    "notify_emails",
    "confirmation",
    "message_count",
    "unread_count",
    "is_sample"
  ],
  "additionalProperties": false
}