{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/autodesk-construction-cloud/json-schema/autodesk-construction-cloud-form-patch-payload-schema.json",
  "title": "FormPatchPayload",
  "description": "The details of the form to update.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/autodesk-construction-cloud-forms-openapi.yml#/components/schemas/FormPatchPayload",
  "type": "object",
  "properties": {
    "assigneeId": {
      "type": "string",
      "description": "The unique identifier of the company, role, or user the form is assigned to. Note that the assignee must be a contributor of the template."
    },
    "assigneeType": {
      "$ref": "#/$defs/AssigneeType"
    },
    "description": {
      "type": "string",
      "description": "Text for the form's description field. Max length: 8000."
    },
    "name": {
      "type": "string",
      "description": "The name of the form instance. If the specified value is null or empty, it defaults to the form's template name. Max length: 100."
    },
    "formDate": {
      "type": "string",
      "description": "Date the form pertains to, must be after 1950-01-01."
    },
    "locationId": {
      "type": "string",
      "format": "uuid",
      "description": "Location identifier associated with the form. For more information about the location, see GET nodes."
    },
    "notes": {
      "type": "string",
      "description": "Text for the form's notes section. Max length: 8000."
    },
    "status": {
      "type": "string",
      "description": "New status for the form. \"draft\" (in progress) forms may be edited. \"inReview\" forms may not be edited but may be approved by the form reviewers. \"submitted\" forms are closed and no longer editable. \"archived\" forms are not editable and hidden in the ui.",
      "enum": [
        "draft",
        "discarded",
        "submitted",
        "archived",
        "in_review"
      ]
    },
    "submitterSignature": {
      "type": "string",
      "description": "Signature of the reviewer who is submitting the form (should be included when submitting an inReview form) as a base64 encoded SVG. Note: the SVG will be sanitized: tags and attributes are limited to the basics (<path>, <g>, <polyline>, etc) needed to represent a signature."
    }
  },
  "$defs": {
    "AssigneeType": {
      "type": "string",
      "description": "Type of entity the form is assigned to. Possible values: company, role, user",
      "enum": [
        "company",
        "role",
        "user"
      ]
    }
  }
}