---
title: "Update a Form"
method: POST
path: "/form/{uuid}.json"
tags: ["Forms"]
---

# Update a Form

`POST /form/{uuid}.json`

#### OAuth Scope
This endpoint requires the following OAuth scope **manage_forms**.

## Path parameters

- `uuid` string, uuid, required

## Request body

- FormCreate
  - `name` string — The name of the form. Used to identify the form in the system and displayed to users in the form selector. Must be unique within an account. Maximum length is 255 characters.
  - `document_template_uuid` string, uuid — UUID of the document template associated with this form. The template defines the layout and appearance of the form when it's generated as a document. References a document template object in the system.
  - `can_be_used_independently` string — Boolean flag indicating whether this form can be used independently of a job. When set to true (1), the form can be filled out as a standalone form. When false (0), the form must be associated with a job to be completed.
  - `badge_mandatory_state` string — Controls when badge completion is mandatory for this form. Valid values are: 0 (not mandatory), 1 (mandatory on check-in), 2 (mandatory on check-out). This determines at which stage in the job lifecycle a staff member must complete this form.
  - `template_fields` object[] — JSON array of template fields that are used when generating form documents. Each field contains a name, fieldType, value, and sortOrder. Maximum of 10 fields allowed.
    - `name` string, required
    - `fieldType` 'Text', required
    - `value` string, required
    - `sortOrder` integer, required
  - `uuid` string, uuid — Unique identifier for this record
  - `badge_name` string

## Response `200`

Success - The record was updated successfully

- Result
  - `errorCode` number
  - `message` string

## Other responses

- `400` — Bad Request - The request is malformed or contains invalid parameters
- `401` — Unauthorized - Authentication credentials are missing or invalid
- `403` — Forbidden - You don't have permission to update this resource
- `404` — Not Found - The record to update does not exist or has been deleted
- `429` — Too Many Requests - You have exceeded the rate limit
- `500` — Internal Server Error - An unexpected error occurred on the server

---

[API](https://skmtc.net/servicem8/apis/servicem8-api.md) · [All operations](https://skmtc.net/servicem8/apis/servicem8-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/servicem8/servicem8-api/versions/53ede60e3653/schema)
