v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Form Fields

This endpoint updates a field on a form. This feature is available as part of the Standard API.

put/forms/{slug_or_id}/fields/{field_key}

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

field_keystring required

The key of the field on the form.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "key": "3jbh8",
  "required": true,
  "type": "address"
}

Response

Successfully updated a field with the provided values

status'ok'

Example response

{
  "results": {
    "field": {
      "key": "3jbh8",
      "required": true,
      "type": "address"
    }
  }
}