Update Form

PATCH/v1/forms/{form_id}

Partially updates a form.

x-api-key<token>

In: header

x-team-id<token>

In: header

Path Parameters

form_idstring
name?string
Length2 <= length <= 50
is_enabled?boolean

Whether the form is enabled or not, disabled forms will not accept new submissions.

limit?integer | null

Number of submissions this form will accept before rejecting new ones.

honeypot_field?string | null

Honeypot field, if filled, submission will be silently discarded.

redirect_url?string | null

The URL to redirect to after a successful submission.

success_title?string

Shown on "Thank You" page

Length2 <= length <= 50
success_message?string

Shown on "Thank You" page

Length2 <= length <= 200

Response Body

curl -X PATCH "https://forms.vexrun.com/v1/forms/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "name": "string",
  "is_enabled": true,
  "limit": null,
  "honeypot_field": null,
  "redirect_url": null,
  "success_title": "string",
  "success_message": "string",
  "created_at": 0,
  "last_submission_at": null
}
{
  "errors": [
    {
      "path": "string",
      "expected": "string",
      "value": null
    }
  ],
  "message": "string"
}
{
  "message": "string"
}