--- title: "Update Field by ID" method: PATCH path: "/sign/envelopes/{envelopeID}/documents/{documentID}/fields/{fieldID}" tags: ["Sign"] --- # Update Field by ID `PATCH /sign/envelopes/{envelopeID}/documents/{documentID}/fields/{fieldID}` The **Update Field by ID** endpoint modifies the properties of an existing field. The Field type cannot be updated. All parameters are optional. ## Path parameters - `envelopeID` string, uuid, required - `documentID` string, uuid, required - `fieldID` string, uuid, required ## Request body - union - UpdateCheckboxField — Parameters to update a Checkbox field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'checkbox', required - UpdateCompanyField — Parameters to update a Company field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'company', required - UpdateCustomField — Parameters to update a Custom field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'custom', required - `label` string — For custom field types, you must provide a descriptive label for the field. - UpdateDateField — Parameters to update a Date field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'date', required - `format` string — For date field types, you can specify the format that will automatically populate when a signer participant opens the document in an envelope. The default value is the date on which the signer opens the envelope. The signer can manually edit the date after it auto-populates, if needed. The following date format options are supported (examples use September 10, 2025): - `MM/DD/YYYY` → 09/10/2025 - `MM-DD-YYYY` → 09-10-2025 - `MMM DD YYYY` → Sep 10 2025 - `DD/MM/YYYY` → 10/09/2025 - `DD MMM YYYY` → 10 Sep 2025 - `DD MMMM YYYY` → 10 September 2025 - `YYYY/MM/DD` → 2025/09/10 - `YYYY-MM-DD` → 2025-09-10 - `YYYY-MMM-DD hh:mm` → 2025-Sep-10 14:30 - `modifiable` boolean — A boolean that indicates that the participant can change value of the field. By default the value of the field is current date and the participant can't change the value. - UpdateInitialsField — Parameters to update a Initials field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'initials', required - UpdateNameField — Parameters to update a Name field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'name', required - UpdateSignatureField — Parameters to update a Signature field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'signature', required - UpdateTitleField — Parameters to update a Title field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` number[] — An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `participantID` string, uuid — The unique identifier of the participant assigned to the field. - `type` 'title', required ## Response `200` Field updated successfully - union - Checkbox — Response representing a Checkbox field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `type` 'checkbox', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Company — Response representing a Company field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `type` 'company', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Custom — Response representing a Custom field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `label` string, required — Descriptive label of the Custom field - `type` 'custom', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Date — Response representing a Date field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `format` string, required — Format of the Date field. The following date format options are supported (examples use September 10, 2025): - `MM/DD/YYYY` → 09/10/2025 - `MM-DD-YYYY` → 09-10-2025 - `MMM DD YYYY` → Sep 10 2025 - `DD/MM/YYYY` → 10/09/2025 - `DD MMM YYYY` → 10 Sep 2025 - `DD MMMM YYYY` → 10 September 2025 - `YYYY/MM/DD` → 2025/09/10 - `YYYY-MM-DD` → 2025-09-10 - `YYYY-MMM-DD hh:mm` → 2025-Sep-10 14:30 - `modifiable` boolean — A boolean that indicates that the participant can change value of the field. - `type` 'date', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Initials — Response representing an Initials field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `type` 'initials', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Name — Response representing a Name field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `type` 'name', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Signature — Response representing a Signature field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `type` 'signature', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. - Title — Response representing a Title field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `boundingBox` string, required — An array of numbers in the format [x, y, w, h] that defines the field's bounding box on the page: - `x, y` are the coordinates of the top-left corner, measured in points (pt). - `w, h` are the width and height of the bounding box, also in points (pt). For more information on calculating positions, see the [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `type` 'title', required - `ID` string, uuid — Unique ID of the field - `participantID` string, uuid, required — The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. - `documentID` string, uuid, required — ID of the document to which this field belongs. ## Other responses - `401` — Unauthorized - Invalid or missing JWT token - `404` — Envelope, document, or field not found --- [API](https://skmtc.net/gonitro/apis/nitro-sign-public-api.md) · [All operations](https://skmtc.net/gonitro/apis/nitro-sign-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gonitro/nitro-sign-public-api/versions/26e3043a365b/schema)