---
title: "Update an Existing Webform"
method: PUT
path: "/webforms/{id}"
---

# Update an Existing Webform

`PUT /webforms/{id}`

This endpoint updates an existing webform owned by the client.

## Path parameters

- `id` integer, required

## Request body

- object
  - `name` string, required — The name used to easily identify the segment. Allowed values are between 2 and 255 characters.
  - `status` string, required — The status of the segment. Allowed values are active and inactive.
  - `sequence_id` integer, required — The associated sequence ID to trigger when the webform is submitted.
  - `captcha_type` string — The type of captcha to include with the form. Allowed values are none, text, recaptcha.
  - `button_text` string, required — Text to display on the submit button for the webform. Allowed values are between 2 and 20 characters.
  - `success_type` string, required — The type of success handler to implement when the form is successfully submitted. Allowed values are send_message, redirect.
  - `success_message` string — The success message to return when the form is submitted. Required when success_type is set to send_message. Allowed values are between 2 and 255 characters.
  - `success_redirect_url` string — The success redirect implemented when the form is submitted. Required when success_type is set to redirect. Allowed values are between 2 and 255 characters.
  - `urls` object[], required — The allowed URLs where a weborm can be submitted from. These URLs should only be the root URL and not the full address to individual pages.
    - `url` string, required — The URL where a webform will be hosted (only the protocol and host should be included). Allowed values are between 2 and 255 characters.
  - `fields` object[], required — Array of webform fields in the order they will be rendered on display.
    - `attribute_id` integer, required — The ID of the attribute associated with the field. The value submitted by a user will be stored as an attribute associated with their profile.
    - `type` string, required — The type of field to be rendered on display. Allowed values are input, input_tel, input_url, input_color, textarea, select, checkbox, hidden, query_param.
    - `params` object, required

## Response `200`

200

- object
  - `webform` object
    - `name` string
    - `guid` string
    - `button_text` string
    - `captcha_type` string
    - `sequence_id` integer
    - `success_type` string
    - `success_message` string
    - `success_redirect_url` unknown
    - `status` string
    - `id` integer

## Other responses

- `422` — 422

---

[API](https://skmtc.dev/seebot/apis/seebottalk.md) · [All operations](https://skmtc.dev/seebot/apis/seebottalk/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/seebot/seebottalk/revisions/4b8c104ade48/schema)