Skip to main content
PATCH
/
sign
/
envelopes
/
{envelopeID}
/
documents
/
{documentID}
/
fields
/
{fieldID}
Update Field by ID
curl --request PATCH \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID}/fields/{fieldID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "boundingBox": [
    100,
    200,
    150,
    50
  ],
  "participantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page": 123,
  "required": true,
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required
​
documentID
string<uuid>
required
​
fieldID
string<uuid>
required

Body

application/json

Parameters to update a Checkbox field

​
type
enum<string>
required
Available options:
checkbox
​
page
integer<int32>

The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.

​
boundingBox
number<float>[]

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.

Required array length: 4 elements
​
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.

Response

Field updated successfully

Response representing a Checkbox field

​
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.

Required string length: 4
Example:
[100, 200, 150, 50]
​
type
enum<string>
required
Available options:
checkbox
​
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.

​
page
integer<int32>

The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.

​
required
boolean

A boolean that indicates whether the participant must complete the field.

​
ID
string<uuid>

Unique ID of the field