PATCH allows for partial updates, this means you do not have to submit the entire form in the body of the PATCH request, only the relevant information that has changes.

Sample Request Body:

{
  "name": "My New Form Name ",   // Changes the name of the form
  "fields": {
    "28b3af03-6ae2-4a1c-9b01-a46c0108d3c5": { //  Referencing field by ID
      "text": "some new text"  // Updating the text on the Report Problem field
    },
    "PO #": { // Referencing by name instead of by ID
      "value": "1223333"  // Updating the PO # on the PO # field 
    }
  }
}

Clearing Form Field Values

To clear a value on a field, set it to null

Sample Clearing Value of a Textbox Field

{
    "Fields": {
        "Reported Problem": null
  }
}

Sample Clearing Value of a Signature Field

{
    "Fields": {
        "Customer Signature": null
  }
}

Assigning Formz

Currently formz cannot be assigned or re-assigned an update (PATCH). Formz can only be assigned upon creation (POST).

Changing the Status of a Form

The status of a form cannot be changed via a PATCH request. To change the status refer the documentation to Complete a Form or Re-open a Form.


Language
Authentication
Basic
base64
: